smscoreapi.c 33 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306
  1. /*
  2. * Siano core API module
  3. *
  4. * This file contains implementation for the interface to sms core component
  5. *
  6. * author: Uri Shkolnik
  7. *
  8. * Copyright (c), 2005-2008 Siano Mobile Silicon, Inc.
  9. *
  10. * This program is free software; you can redistribute it and/or modify
  11. * it under the terms of the GNU General Public License version 2 as
  12. * published by the Free Software Foundation;
  13. *
  14. * Software distributed under the License is distributed on an "AS IS"
  15. * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
  16. *
  17. * See the GNU General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU General Public License
  20. * along with this program; if not, write to the Free Software
  21. * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22. */
  23. #include <linux/kernel.h>
  24. #include <linux/init.h>
  25. #include <linux/module.h>
  26. #include <linux/moduleparam.h>
  27. #include <linux/dma-mapping.h>
  28. #include <linux/delay.h>
  29. #include <linux/io.h>
  30. #include <linux/firmware.h>
  31. #include "smscoreapi.h"
  32. #include "sms-cards.h"
  33. static int sms_dbg;
  34. module_param_named(debug, sms_dbg, int, 0644);
  35. MODULE_PARM_DESC(debug, "set debug level (info=1, adv=2 (or-able))");
  36. struct smscore_device_notifyee_t {
  37. struct list_head entry;
  38. hotplug_t hotplug;
  39. };
  40. struct smscore_idlist_t {
  41. struct list_head entry;
  42. int id;
  43. int data_type;
  44. };
  45. struct smscore_client_t {
  46. struct list_head entry;
  47. struct smscore_device_t *coredev;
  48. void *context;
  49. struct list_head idlist;
  50. onresponse_t onresponse_handler;
  51. onremove_t onremove_handler;
  52. };
  53. void smscore_set_board_id(struct smscore_device_t *core, int id)
  54. {
  55. core->board_id = id;
  56. }
  57. int smscore_led_state(struct smscore_device_t *core, int led)
  58. {
  59. if (led >= 0)
  60. core->led_state = led;
  61. return core->led_state;
  62. }
  63. EXPORT_SYMBOL_GPL(smscore_set_board_id);
  64. int smscore_get_board_id(struct smscore_device_t *core)
  65. {
  66. return core->board_id;
  67. }
  68. EXPORT_SYMBOL_GPL(smscore_get_board_id);
  69. struct smscore_registry_entry_t {
  70. struct list_head entry;
  71. char devpath[32];
  72. int mode;
  73. enum sms_device_type_st type;
  74. };
  75. static struct list_head g_smscore_notifyees;
  76. static struct list_head g_smscore_devices;
  77. static struct mutex g_smscore_deviceslock;
  78. static struct list_head g_smscore_registry;
  79. static struct mutex g_smscore_registrylock;
  80. static int default_mode = 4;
  81. module_param(default_mode, int, 0644);
  82. MODULE_PARM_DESC(default_mode, "default firmware id (device mode)");
  83. static struct smscore_registry_entry_t *smscore_find_registry(char *devpath)
  84. {
  85. struct smscore_registry_entry_t *entry;
  86. struct list_head *next;
  87. kmutex_lock(&g_smscore_registrylock);
  88. for (next = g_smscore_registry.next;
  89. next != &g_smscore_registry;
  90. next = next->next) {
  91. entry = (struct smscore_registry_entry_t *) next;
  92. if (!strcmp(entry->devpath, devpath)) {
  93. kmutex_unlock(&g_smscore_registrylock);
  94. return entry;
  95. }
  96. }
  97. entry = (struct smscore_registry_entry_t *)
  98. kmalloc(sizeof(struct smscore_registry_entry_t),
  99. GFP_KERNEL);
  100. if (entry) {
  101. entry->mode = default_mode;
  102. strcpy(entry->devpath, devpath);
  103. list_add(&entry->entry, &g_smscore_registry);
  104. } else
  105. sms_err("failed to create smscore_registry.");
  106. kmutex_unlock(&g_smscore_registrylock);
  107. return entry;
  108. }
  109. int smscore_registry_getmode(char *devpath)
  110. {
  111. struct smscore_registry_entry_t *entry;
  112. entry = smscore_find_registry(devpath);
  113. if (entry)
  114. return entry->mode;
  115. else
  116. sms_err("No registry found.");
  117. return default_mode;
  118. }
  119. EXPORT_SYMBOL_GPL(smscore_registry_getmode);
  120. static enum sms_device_type_st smscore_registry_gettype(char *devpath)
  121. {
  122. struct smscore_registry_entry_t *entry;
  123. entry = smscore_find_registry(devpath);
  124. if (entry)
  125. return entry->type;
  126. else
  127. sms_err("No registry found.");
  128. return -1;
  129. }
  130. void smscore_registry_setmode(char *devpath, int mode)
  131. {
  132. struct smscore_registry_entry_t *entry;
  133. entry = smscore_find_registry(devpath);
  134. if (entry)
  135. entry->mode = mode;
  136. else
  137. sms_err("No registry found.");
  138. }
  139. static void smscore_registry_settype(char *devpath,
  140. enum sms_device_type_st type)
  141. {
  142. struct smscore_registry_entry_t *entry;
  143. entry = smscore_find_registry(devpath);
  144. if (entry)
  145. entry->type = type;
  146. else
  147. sms_err("No registry found.");
  148. }
  149. static void list_add_locked(struct list_head *new, struct list_head *head,
  150. spinlock_t *lock)
  151. {
  152. unsigned long flags;
  153. spin_lock_irqsave(lock, flags);
  154. list_add(new, head);
  155. spin_unlock_irqrestore(lock, flags);
  156. }
  157. /**
  158. * register a client callback that called when device plugged in/unplugged
  159. * NOTE: if devices exist callback is called immediately for each device
  160. *
  161. * @param hotplug callback
  162. *
  163. * @return 0 on success, <0 on error.
  164. */
  165. int smscore_register_hotplug(hotplug_t hotplug)
  166. {
  167. struct smscore_device_notifyee_t *notifyee;
  168. struct list_head *next, *first;
  169. int rc = 0;
  170. kmutex_lock(&g_smscore_deviceslock);
  171. notifyee = kmalloc(sizeof(struct smscore_device_notifyee_t),
  172. GFP_KERNEL);
  173. if (notifyee) {
  174. /* now notify callback about existing devices */
  175. first = &g_smscore_devices;
  176. for (next = first->next;
  177. next != first && !rc;
  178. next = next->next) {
  179. struct smscore_device_t *coredev =
  180. (struct smscore_device_t *) next;
  181. rc = hotplug(coredev, coredev->device, 1);
  182. }
  183. if (rc >= 0) {
  184. notifyee->hotplug = hotplug;
  185. list_add(&notifyee->entry, &g_smscore_notifyees);
  186. } else
  187. kfree(notifyee);
  188. } else
  189. rc = -ENOMEM;
  190. kmutex_unlock(&g_smscore_deviceslock);
  191. return rc;
  192. }
  193. EXPORT_SYMBOL_GPL(smscore_register_hotplug);
  194. /**
  195. * unregister a client callback that called when device plugged in/unplugged
  196. *
  197. * @param hotplug callback
  198. *
  199. */
  200. void smscore_unregister_hotplug(hotplug_t hotplug)
  201. {
  202. struct list_head *next, *first;
  203. kmutex_lock(&g_smscore_deviceslock);
  204. first = &g_smscore_notifyees;
  205. for (next = first->next; next != first;) {
  206. struct smscore_device_notifyee_t *notifyee =
  207. (struct smscore_device_notifyee_t *) next;
  208. next = next->next;
  209. if (notifyee->hotplug == hotplug) {
  210. list_del(&notifyee->entry);
  211. kfree(notifyee);
  212. }
  213. }
  214. kmutex_unlock(&g_smscore_deviceslock);
  215. }
  216. EXPORT_SYMBOL_GPL(smscore_unregister_hotplug);
  217. static void smscore_notify_clients(struct smscore_device_t *coredev)
  218. {
  219. struct smscore_client_t *client;
  220. /* the client must call smscore_unregister_client from remove handler */
  221. while (!list_empty(&coredev->clients)) {
  222. client = (struct smscore_client_t *) coredev->clients.next;
  223. client->onremove_handler(client->context);
  224. }
  225. }
  226. static int smscore_notify_callbacks(struct smscore_device_t *coredev,
  227. struct device *device, int arrival)
  228. {
  229. struct list_head *next, *first;
  230. int rc = 0;
  231. /* note: must be called under g_deviceslock */
  232. first = &g_smscore_notifyees;
  233. for (next = first->next; next != first; next = next->next) {
  234. rc = ((struct smscore_device_notifyee_t *) next)->
  235. hotplug(coredev, device, arrival);
  236. if (rc < 0)
  237. break;
  238. }
  239. return rc;
  240. }
  241. static struct
  242. smscore_buffer_t *smscore_createbuffer(u8 *buffer, void *common_buffer,
  243. dma_addr_t common_buffer_phys)
  244. {
  245. struct smscore_buffer_t *cb =
  246. kmalloc(sizeof(struct smscore_buffer_t), GFP_KERNEL);
  247. if (!cb) {
  248. sms_info("kmalloc(...) failed");
  249. return NULL;
  250. }
  251. cb->p = buffer;
  252. cb->offset_in_common = buffer - (u8 *) common_buffer;
  253. cb->phys = common_buffer_phys + cb->offset_in_common;
  254. return cb;
  255. }
  256. /**
  257. * creates coredev object for a device, prepares buffers,
  258. * creates buffer mappings, notifies registered hotplugs about new device.
  259. *
  260. * @param params device pointer to struct with device specific parameters
  261. * and handlers
  262. * @param coredev pointer to a value that receives created coredev object
  263. *
  264. * @return 0 on success, <0 on error.
  265. */
  266. int smscore_register_device(struct smsdevice_params_t *params,
  267. struct smscore_device_t **coredev)
  268. {
  269. struct smscore_device_t *dev;
  270. u8 *buffer;
  271. dev = kzalloc(sizeof(struct smscore_device_t), GFP_KERNEL);
  272. if (!dev) {
  273. sms_info("kzalloc(...) failed");
  274. return -ENOMEM;
  275. }
  276. /* init list entry so it could be safe in smscore_unregister_device */
  277. INIT_LIST_HEAD(&dev->entry);
  278. /* init queues */
  279. INIT_LIST_HEAD(&dev->clients);
  280. INIT_LIST_HEAD(&dev->buffers);
  281. /* init locks */
  282. spin_lock_init(&dev->clientslock);
  283. spin_lock_init(&dev->bufferslock);
  284. /* init completion events */
  285. init_completion(&dev->version_ex_done);
  286. init_completion(&dev->data_download_done);
  287. init_completion(&dev->trigger_done);
  288. init_completion(&dev->init_device_done);
  289. init_completion(&dev->reload_start_done);
  290. init_completion(&dev->resume_done);
  291. /* alloc common buffer */
  292. dev->common_buffer_size = params->buffer_size * params->num_buffers;
  293. dev->common_buffer = dma_alloc_coherent(NULL, dev->common_buffer_size,
  294. &dev->common_buffer_phys,
  295. GFP_KERNEL | GFP_DMA);
  296. if (!dev->common_buffer) {
  297. smscore_unregister_device(dev);
  298. return -ENOMEM;
  299. }
  300. /* prepare dma buffers */
  301. for (buffer = dev->common_buffer;
  302. dev->num_buffers < params->num_buffers;
  303. dev->num_buffers++, buffer += params->buffer_size) {
  304. struct smscore_buffer_t *cb =
  305. smscore_createbuffer(buffer, dev->common_buffer,
  306. dev->common_buffer_phys);
  307. if (!cb) {
  308. smscore_unregister_device(dev);
  309. return -ENOMEM;
  310. }
  311. smscore_putbuffer(dev, cb);
  312. }
  313. sms_info("allocated %d buffers", dev->num_buffers);
  314. dev->mode = DEVICE_MODE_NONE;
  315. dev->context = params->context;
  316. dev->device = params->device;
  317. dev->setmode_handler = params->setmode_handler;
  318. dev->detectmode_handler = params->detectmode_handler;
  319. dev->sendrequest_handler = params->sendrequest_handler;
  320. dev->preload_handler = params->preload_handler;
  321. dev->postload_handler = params->postload_handler;
  322. dev->device_flags = params->flags;
  323. strcpy(dev->devpath, params->devpath);
  324. smscore_registry_settype(dev->devpath, params->device_type);
  325. /* add device to devices list */
  326. kmutex_lock(&g_smscore_deviceslock);
  327. list_add(&dev->entry, &g_smscore_devices);
  328. kmutex_unlock(&g_smscore_deviceslock);
  329. *coredev = dev;
  330. sms_info("device %p created", dev);
  331. return 0;
  332. }
  333. EXPORT_SYMBOL_GPL(smscore_register_device);
  334. /**
  335. * sets initial device mode and notifies client hotplugs that device is ready
  336. *
  337. * @param coredev pointer to a coredev object returned by
  338. * smscore_register_device
  339. *
  340. * @return 0 on success, <0 on error.
  341. */
  342. int smscore_start_device(struct smscore_device_t *coredev)
  343. {
  344. int rc = smscore_set_device_mode(
  345. coredev, smscore_registry_getmode(coredev->devpath));
  346. if (rc < 0) {
  347. sms_info("set device mode faile , rc %d", rc);
  348. return rc;
  349. }
  350. kmutex_lock(&g_smscore_deviceslock);
  351. rc = smscore_notify_callbacks(coredev, coredev->device, 1);
  352. sms_info("device %p started, rc %d", coredev, rc);
  353. kmutex_unlock(&g_smscore_deviceslock);
  354. return rc;
  355. }
  356. EXPORT_SYMBOL_GPL(smscore_start_device);
  357. static int smscore_sendrequest_and_wait(struct smscore_device_t *coredev,
  358. void *buffer, size_t size,
  359. struct completion *completion)
  360. {
  361. int rc = coredev->sendrequest_handler(coredev->context, buffer, size);
  362. if (rc < 0) {
  363. sms_info("sendrequest returned error %d", rc);
  364. return rc;
  365. }
  366. return wait_for_completion_timeout(completion,
  367. msecs_to_jiffies(10000)) ?
  368. 0 : -ETIME;
  369. }
  370. static int smscore_load_firmware_family2(struct smscore_device_t *coredev,
  371. void *buffer, size_t size)
  372. {
  373. struct SmsFirmware_ST *firmware = (struct SmsFirmware_ST *) buffer;
  374. struct SmsMsgHdr_ST *msg;
  375. u32 mem_address = firmware->StartAddress;
  376. u8 *payload = firmware->Payload;
  377. int rc = 0;
  378. sms_info("loading FW to addr 0x%x size %d",
  379. mem_address, firmware->Length);
  380. if (coredev->preload_handler) {
  381. rc = coredev->preload_handler(coredev->context);
  382. if (rc < 0)
  383. return rc;
  384. }
  385. /* PAGE_SIZE buffer shall be enough and dma aligned */
  386. msg = kmalloc(PAGE_SIZE, GFP_KERNEL | GFP_DMA);
  387. if (!msg)
  388. return -ENOMEM;
  389. if (coredev->mode != DEVICE_MODE_NONE) {
  390. sms_debug("sending reload command.");
  391. SMS_INIT_MSG(msg, MSG_SW_RELOAD_START_REQ,
  392. sizeof(struct SmsMsgHdr_ST));
  393. rc = smscore_sendrequest_and_wait(coredev, msg,
  394. msg->msgLength,
  395. &coredev->reload_start_done);
  396. mem_address = *(u32 *) &payload[20];
  397. }
  398. while (size && rc >= 0) {
  399. struct SmsDataDownload_ST *DataMsg =
  400. (struct SmsDataDownload_ST *) msg;
  401. int payload_size = min((int) size, SMS_MAX_PAYLOAD_SIZE);
  402. SMS_INIT_MSG(msg, MSG_SMS_DATA_DOWNLOAD_REQ,
  403. (u16)(sizeof(struct SmsMsgHdr_ST) +
  404. sizeof(u32) + payload_size));
  405. DataMsg->MemAddr = mem_address;
  406. memcpy(DataMsg->Payload, payload, payload_size);
  407. if ((coredev->device_flags & SMS_ROM_NO_RESPONSE) &&
  408. (coredev->mode == DEVICE_MODE_NONE))
  409. rc = coredev->sendrequest_handler(
  410. coredev->context, DataMsg,
  411. DataMsg->xMsgHeader.msgLength);
  412. else
  413. rc = smscore_sendrequest_and_wait(
  414. coredev, DataMsg,
  415. DataMsg->xMsgHeader.msgLength,
  416. &coredev->data_download_done);
  417. payload += payload_size;
  418. size -= payload_size;
  419. mem_address += payload_size;
  420. }
  421. if (rc >= 0) {
  422. if (coredev->mode == DEVICE_MODE_NONE) {
  423. struct SmsMsgData_ST *TriggerMsg =
  424. (struct SmsMsgData_ST *) msg;
  425. SMS_INIT_MSG(msg, MSG_SMS_SWDOWNLOAD_TRIGGER_REQ,
  426. sizeof(struct SmsMsgHdr_ST) +
  427. sizeof(u32) * 5);
  428. TriggerMsg->msgData[0] = firmware->StartAddress;
  429. /* Entry point */
  430. TriggerMsg->msgData[1] = 5; /* Priority */
  431. TriggerMsg->msgData[2] = 0x200; /* Stack size */
  432. TriggerMsg->msgData[3] = 0; /* Parameter */
  433. TriggerMsg->msgData[4] = 4; /* Task ID */
  434. if (coredev->device_flags & SMS_ROM_NO_RESPONSE) {
  435. rc = coredev->sendrequest_handler(
  436. coredev->context, TriggerMsg,
  437. TriggerMsg->xMsgHeader.msgLength);
  438. msleep(100);
  439. } else
  440. rc = smscore_sendrequest_and_wait(
  441. coredev, TriggerMsg,
  442. TriggerMsg->xMsgHeader.msgLength,
  443. &coredev->trigger_done);
  444. } else {
  445. SMS_INIT_MSG(msg, MSG_SW_RELOAD_EXEC_REQ,
  446. sizeof(struct SmsMsgHdr_ST));
  447. rc = coredev->sendrequest_handler(coredev->context,
  448. msg, msg->msgLength);
  449. }
  450. msleep(500);
  451. }
  452. sms_debug("rc=%d, postload=%p ", rc,
  453. coredev->postload_handler);
  454. kfree(msg);
  455. return ((rc >= 0) && coredev->postload_handler) ?
  456. coredev->postload_handler(coredev->context) :
  457. rc;
  458. }
  459. /**
  460. * loads specified firmware into a buffer and calls device loadfirmware_handler
  461. *
  462. * @param coredev pointer to a coredev object returned by
  463. * smscore_register_device
  464. * @param filename null-terminated string specifies firmware file name
  465. * @param loadfirmware_handler device handler that loads firmware
  466. *
  467. * @return 0 on success, <0 on error.
  468. */
  469. static int smscore_load_firmware_from_file(struct smscore_device_t *coredev,
  470. char *filename,
  471. loadfirmware_t loadfirmware_handler)
  472. {
  473. int rc = -ENOENT;
  474. const struct firmware *fw;
  475. u8 *fw_buffer;
  476. if (loadfirmware_handler == NULL && !(coredev->device_flags &
  477. SMS_DEVICE_FAMILY2))
  478. return -EINVAL;
  479. rc = request_firmware(&fw, filename, coredev->device);
  480. if (rc < 0) {
  481. sms_info("failed to open \"%s\"", filename);
  482. return rc;
  483. }
  484. sms_info("read FW %s, size=%zd", filename, fw->size);
  485. fw_buffer = kmalloc(ALIGN(fw->size, SMS_ALLOC_ALIGNMENT),
  486. GFP_KERNEL | GFP_DMA);
  487. if (fw_buffer) {
  488. memcpy(fw_buffer, fw->data, fw->size);
  489. rc = (coredev->device_flags & SMS_DEVICE_FAMILY2) ?
  490. smscore_load_firmware_family2(coredev,
  491. fw_buffer,
  492. fw->size) :
  493. loadfirmware_handler(coredev->context,
  494. fw_buffer, fw->size);
  495. kfree(fw_buffer);
  496. } else {
  497. sms_info("failed to allocate firmware buffer");
  498. rc = -ENOMEM;
  499. }
  500. release_firmware(fw);
  501. return rc;
  502. }
  503. /**
  504. * notifies all clients registered with the device, notifies hotplugs,
  505. * frees all buffers and coredev object
  506. *
  507. * @param coredev pointer to a coredev object returned by
  508. * smscore_register_device
  509. *
  510. * @return 0 on success, <0 on error.
  511. */
  512. void smscore_unregister_device(struct smscore_device_t *coredev)
  513. {
  514. struct smscore_buffer_t *cb;
  515. int num_buffers = 0;
  516. int retry = 0;
  517. kmutex_lock(&g_smscore_deviceslock);
  518. smscore_notify_clients(coredev);
  519. smscore_notify_callbacks(coredev, NULL, 0);
  520. /* at this point all buffers should be back
  521. * onresponse must no longer be called */
  522. while (1) {
  523. while ((cb = smscore_getbuffer(coredev))) {
  524. kfree(cb);
  525. num_buffers++;
  526. }
  527. if (num_buffers == coredev->num_buffers)
  528. break;
  529. if (++retry > 10) {
  530. sms_info("exiting although "
  531. "not all buffers released.");
  532. break;
  533. }
  534. sms_info("waiting for %d buffer(s)",
  535. coredev->num_buffers - num_buffers);
  536. msleep(100);
  537. }
  538. sms_info("freed %d buffers", num_buffers);
  539. if (coredev->common_buffer)
  540. dma_free_coherent(NULL, coredev->common_buffer_size,
  541. coredev->common_buffer,
  542. coredev->common_buffer_phys);
  543. list_del(&coredev->entry);
  544. kfree(coredev);
  545. kmutex_unlock(&g_smscore_deviceslock);
  546. sms_info("device %p destroyed", coredev);
  547. }
  548. EXPORT_SYMBOL_GPL(smscore_unregister_device);
  549. static int smscore_detect_mode(struct smscore_device_t *coredev)
  550. {
  551. void *buffer = kmalloc(sizeof(struct SmsMsgHdr_ST) + SMS_DMA_ALIGNMENT,
  552. GFP_KERNEL | GFP_DMA);
  553. struct SmsMsgHdr_ST *msg =
  554. (struct SmsMsgHdr_ST *) SMS_ALIGN_ADDRESS(buffer);
  555. int rc;
  556. if (!buffer)
  557. return -ENOMEM;
  558. SMS_INIT_MSG(msg, MSG_SMS_GET_VERSION_EX_REQ,
  559. sizeof(struct SmsMsgHdr_ST));
  560. rc = smscore_sendrequest_and_wait(coredev, msg, msg->msgLength,
  561. &coredev->version_ex_done);
  562. if (rc == -ETIME) {
  563. sms_err("MSG_SMS_GET_VERSION_EX_REQ failed first try");
  564. if (wait_for_completion_timeout(&coredev->resume_done,
  565. msecs_to_jiffies(5000))) {
  566. rc = smscore_sendrequest_and_wait(
  567. coredev, msg, msg->msgLength,
  568. &coredev->version_ex_done);
  569. if (rc < 0)
  570. sms_err("MSG_SMS_GET_VERSION_EX_REQ failed "
  571. "second try, rc %d", rc);
  572. } else
  573. rc = -ETIME;
  574. }
  575. kfree(buffer);
  576. return rc;
  577. }
  578. static char *smscore_fw_lkup[][SMS_NUM_OF_DEVICE_TYPES] = {
  579. /*Stellar NOVA A0 Nova B0 VEGA*/
  580. /*DVBT*/
  581. {"none", "dvb_nova_12mhz.inp", "dvb_nova_12mhz_b0.inp", "none"},
  582. /*DVBH*/
  583. {"none", "dvb_nova_12mhz.inp", "dvb_nova_12mhz_b0.inp", "none"},
  584. /*TDMB*/
  585. {"none", "tdmb_nova_12mhz.inp", "tdmb_nova_12mhz_b0.inp", "none"},
  586. /*DABIP*/
  587. {"none", "none", "none", "none"},
  588. /*BDA*/
  589. {"none", "dvb_nova_12mhz.inp", "dvb_nova_12mhz_b0.inp", "none"},
  590. /*ISDBT*/
  591. {"none", "isdbt_nova_12mhz.inp", "dvb_nova_12mhz.inp", "none"},
  592. /*ISDBTBDA*/
  593. {"none", "isdbt_nova_12mhz.inp", "isdbt_nova_12mhz_b0.inp", "none"},
  594. /*CMMB*/
  595. {"none", "none", "none", "cmmb_vega_12mhz.inp"}
  596. };
  597. static inline char *sms_get_fw_name(struct smscore_device_t *coredev,
  598. int mode, enum sms_device_type_st type)
  599. {
  600. char **fw = sms_get_board(smscore_get_board_id(coredev))->fw;
  601. return (fw && fw[mode]) ? fw[mode] : smscore_fw_lkup[mode][type];
  602. }
  603. /**
  604. * calls device handler to change mode of operation
  605. * NOTE: stellar/usb may disconnect when changing mode
  606. *
  607. * @param coredev pointer to a coredev object returned by
  608. * smscore_register_device
  609. * @param mode requested mode of operation
  610. *
  611. * @return 0 on success, <0 on error.
  612. */
  613. int smscore_set_device_mode(struct smscore_device_t *coredev, int mode)
  614. {
  615. void *buffer;
  616. int rc = 0;
  617. enum sms_device_type_st type;
  618. sms_debug("set device mode to %d", mode);
  619. if (coredev->device_flags & SMS_DEVICE_FAMILY2) {
  620. if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_RAW_TUNER) {
  621. sms_err("invalid mode specified %d", mode);
  622. return -EINVAL;
  623. }
  624. smscore_registry_setmode(coredev->devpath, mode);
  625. if (!(coredev->device_flags & SMS_DEVICE_NOT_READY)) {
  626. rc = smscore_detect_mode(coredev);
  627. if (rc < 0) {
  628. sms_err("mode detect failed %d", rc);
  629. return rc;
  630. }
  631. }
  632. if (coredev->mode == mode) {
  633. sms_info("device mode %d already set", mode);
  634. return 0;
  635. }
  636. if (!(coredev->modes_supported & (1 << mode))) {
  637. char *fw_filename;
  638. type = smscore_registry_gettype(coredev->devpath);
  639. fw_filename = sms_get_fw_name(coredev, mode, type);
  640. rc = smscore_load_firmware_from_file(coredev,
  641. fw_filename, NULL);
  642. if (rc < 0) {
  643. sms_warn("error %d loading firmware: %s, "
  644. "trying again with default firmware",
  645. rc, fw_filename);
  646. /* try again with the default firmware */
  647. fw_filename = smscore_fw_lkup[mode][type];
  648. rc = smscore_load_firmware_from_file(coredev,
  649. fw_filename, NULL);
  650. if (rc < 0) {
  651. sms_warn("error %d loading "
  652. "firmware: %s", rc,
  653. fw_filename);
  654. return rc;
  655. }
  656. }
  657. sms_log("firmware download success: %s", fw_filename);
  658. } else
  659. sms_info("mode %d supported by running "
  660. "firmware", mode);
  661. buffer = kmalloc(sizeof(struct SmsMsgData_ST) +
  662. SMS_DMA_ALIGNMENT, GFP_KERNEL | GFP_DMA);
  663. if (buffer) {
  664. struct SmsMsgData_ST *msg =
  665. (struct SmsMsgData_ST *)
  666. SMS_ALIGN_ADDRESS(buffer);
  667. SMS_INIT_MSG(&msg->xMsgHeader, MSG_SMS_INIT_DEVICE_REQ,
  668. sizeof(struct SmsMsgData_ST));
  669. msg->msgData[0] = mode;
  670. rc = smscore_sendrequest_and_wait(
  671. coredev, msg, msg->xMsgHeader.msgLength,
  672. &coredev->init_device_done);
  673. kfree(buffer);
  674. } else {
  675. sms_err("Could not allocate buffer for "
  676. "init device message.");
  677. rc = -ENOMEM;
  678. }
  679. } else {
  680. if (mode < DEVICE_MODE_DVBT || mode > DEVICE_MODE_DVBT_BDA) {
  681. sms_err("invalid mode specified %d", mode);
  682. return -EINVAL;
  683. }
  684. smscore_registry_setmode(coredev->devpath, mode);
  685. if (coredev->detectmode_handler)
  686. coredev->detectmode_handler(coredev->context,
  687. &coredev->mode);
  688. if (coredev->mode != mode && coredev->setmode_handler)
  689. rc = coredev->setmode_handler(coredev->context, mode);
  690. }
  691. if (rc >= 0) {
  692. coredev->mode = mode;
  693. coredev->device_flags &= ~SMS_DEVICE_NOT_READY;
  694. }
  695. if (rc != 0)
  696. sms_err("return error code %d.", rc);
  697. return rc;
  698. }
  699. /**
  700. * calls device handler to get current mode of operation
  701. *
  702. * @param coredev pointer to a coredev object returned by
  703. * smscore_register_device
  704. *
  705. * @return current mode
  706. */
  707. int smscore_get_device_mode(struct smscore_device_t *coredev)
  708. {
  709. return coredev->mode;
  710. }
  711. EXPORT_SYMBOL_GPL(smscore_get_device_mode);
  712. /**
  713. * find client by response id & type within the clients list.
  714. * return client handle or NULL.
  715. *
  716. * @param coredev pointer to a coredev object returned by
  717. * smscore_register_device
  718. * @param data_type client data type (SMS_DONT_CARE for all types)
  719. * @param id client id (SMS_DONT_CARE for all id)
  720. *
  721. */
  722. static struct
  723. smscore_client_t *smscore_find_client(struct smscore_device_t *coredev,
  724. int data_type, int id)
  725. {
  726. struct smscore_client_t *client = NULL;
  727. struct list_head *next, *first;
  728. unsigned long flags;
  729. struct list_head *firstid, *nextid;
  730. spin_lock_irqsave(&coredev->clientslock, flags);
  731. first = &coredev->clients;
  732. for (next = first->next;
  733. (next != first) && !client;
  734. next = next->next) {
  735. firstid = &((struct smscore_client_t *)next)->idlist;
  736. for (nextid = firstid->next;
  737. nextid != firstid;
  738. nextid = nextid->next) {
  739. if ((((struct smscore_idlist_t *)nextid)->id == id) &&
  740. (((struct smscore_idlist_t *)nextid)->data_type == data_type ||
  741. (((struct smscore_idlist_t *)nextid)->data_type == 0))) {
  742. client = (struct smscore_client_t *) next;
  743. break;
  744. }
  745. }
  746. }
  747. spin_unlock_irqrestore(&coredev->clientslock, flags);
  748. return client;
  749. }
  750. /**
  751. * find client by response id/type, call clients onresponse handler
  752. * return buffer to pool on error
  753. *
  754. * @param coredev pointer to a coredev object returned by
  755. * smscore_register_device
  756. * @param cb pointer to response buffer descriptor
  757. *
  758. */
  759. void smscore_onresponse(struct smscore_device_t *coredev,
  760. struct smscore_buffer_t *cb)
  761. {
  762. struct SmsMsgHdr_ST *phdr =
  763. (struct SmsMsgHdr_ST *)((u8 *) cb->p + cb->offset);
  764. struct smscore_client_t *client =
  765. smscore_find_client(coredev, phdr->msgType, phdr->msgDstId);
  766. int rc = -EBUSY;
  767. static unsigned long last_sample_time; /* = 0; */
  768. static int data_total; /* = 0; */
  769. unsigned long time_now = jiffies_to_msecs(jiffies);
  770. if (!last_sample_time)
  771. last_sample_time = time_now;
  772. if (time_now - last_sample_time > 10000) {
  773. sms_debug("\ndata rate %d bytes/secs",
  774. (int)((data_total * 1000) /
  775. (time_now - last_sample_time)));
  776. last_sample_time = time_now;
  777. data_total = 0;
  778. }
  779. data_total += cb->size;
  780. /* If no client registered for type & id,
  781. * check for control client where type is not registered */
  782. if (client)
  783. rc = client->onresponse_handler(client->context, cb);
  784. if (rc < 0) {
  785. switch (phdr->msgType) {
  786. case MSG_SMS_GET_VERSION_EX_RES:
  787. {
  788. struct SmsVersionRes_ST *ver =
  789. (struct SmsVersionRes_ST *) phdr;
  790. sms_debug("MSG_SMS_GET_VERSION_EX_RES "
  791. "id %d prots 0x%x ver %d.%d",
  792. ver->FirmwareId, ver->SupportedProtocols,
  793. ver->RomVersionMajor, ver->RomVersionMinor);
  794. coredev->mode = ver->FirmwareId == 255 ?
  795. DEVICE_MODE_NONE : ver->FirmwareId;
  796. coredev->modes_supported = ver->SupportedProtocols;
  797. complete(&coredev->version_ex_done);
  798. break;
  799. }
  800. case MSG_SMS_INIT_DEVICE_RES:
  801. sms_debug("MSG_SMS_INIT_DEVICE_RES");
  802. complete(&coredev->init_device_done);
  803. break;
  804. case MSG_SW_RELOAD_START_RES:
  805. sms_debug("MSG_SW_RELOAD_START_RES");
  806. complete(&coredev->reload_start_done);
  807. break;
  808. case MSG_SMS_DATA_DOWNLOAD_RES:
  809. complete(&coredev->data_download_done);
  810. break;
  811. case MSG_SW_RELOAD_EXEC_RES:
  812. sms_debug("MSG_SW_RELOAD_EXEC_RES");
  813. break;
  814. case MSG_SMS_SWDOWNLOAD_TRIGGER_RES:
  815. sms_debug("MSG_SMS_SWDOWNLOAD_TRIGGER_RES");
  816. complete(&coredev->trigger_done);
  817. break;
  818. case MSG_SMS_SLEEP_RESUME_COMP_IND:
  819. complete(&coredev->resume_done);
  820. break;
  821. default:
  822. break;
  823. }
  824. smscore_putbuffer(coredev, cb);
  825. }
  826. }
  827. EXPORT_SYMBOL_GPL(smscore_onresponse);
  828. /**
  829. * return pointer to next free buffer descriptor from core pool
  830. *
  831. * @param coredev pointer to a coredev object returned by
  832. * smscore_register_device
  833. *
  834. * @return pointer to descriptor on success, NULL on error.
  835. */
  836. struct smscore_buffer_t *smscore_getbuffer(struct smscore_device_t *coredev)
  837. {
  838. struct smscore_buffer_t *cb = NULL;
  839. unsigned long flags;
  840. spin_lock_irqsave(&coredev->bufferslock, flags);
  841. if (!list_empty(&coredev->buffers)) {
  842. cb = (struct smscore_buffer_t *) coredev->buffers.next;
  843. list_del(&cb->entry);
  844. }
  845. spin_unlock_irqrestore(&coredev->bufferslock, flags);
  846. return cb;
  847. }
  848. EXPORT_SYMBOL_GPL(smscore_getbuffer);
  849. /**
  850. * return buffer descriptor to a pool
  851. *
  852. * @param coredev pointer to a coredev object returned by
  853. * smscore_register_device
  854. * @param cb pointer buffer descriptor
  855. *
  856. */
  857. void smscore_putbuffer(struct smscore_device_t *coredev,
  858. struct smscore_buffer_t *cb)
  859. {
  860. list_add_locked(&cb->entry, &coredev->buffers, &coredev->bufferslock);
  861. }
  862. EXPORT_SYMBOL_GPL(smscore_putbuffer);
  863. static int smscore_validate_client(struct smscore_device_t *coredev,
  864. struct smscore_client_t *client,
  865. int data_type, int id)
  866. {
  867. struct smscore_idlist_t *listentry;
  868. struct smscore_client_t *registered_client;
  869. if (!client) {
  870. sms_err("bad parameter.");
  871. return -EFAULT;
  872. }
  873. registered_client = smscore_find_client(coredev, data_type, id);
  874. if (registered_client == client)
  875. return 0;
  876. if (registered_client) {
  877. sms_err("The msg ID already registered to another client.");
  878. return -EEXIST;
  879. }
  880. listentry = kzalloc(sizeof(struct smscore_idlist_t), GFP_KERNEL);
  881. if (!listentry) {
  882. sms_err("Can't allocate memory for client id.");
  883. return -ENOMEM;
  884. }
  885. listentry->id = id;
  886. listentry->data_type = data_type;
  887. list_add_locked(&listentry->entry, &client->idlist,
  888. &coredev->clientslock);
  889. return 0;
  890. }
  891. /**
  892. * creates smsclient object, check that id is taken by another client
  893. *
  894. * @param coredev pointer to a coredev object from clients hotplug
  895. * @param initial_id all messages with this id would be sent to this client
  896. * @param data_type all messages of this type would be sent to this client
  897. * @param onresponse_handler client handler that is called to
  898. * process incoming messages
  899. * @param onremove_handler client handler that is called when device is removed
  900. * @param context client-specific context
  901. * @param client pointer to a value that receives created smsclient object
  902. *
  903. * @return 0 on success, <0 on error.
  904. */
  905. int smscore_register_client(struct smscore_device_t *coredev,
  906. struct smsclient_params_t *params,
  907. struct smscore_client_t **client)
  908. {
  909. struct smscore_client_t *newclient;
  910. /* check that no other channel with same parameters exists */
  911. if (smscore_find_client(coredev, params->data_type,
  912. params->initial_id)) {
  913. sms_err("Client already exist.");
  914. return -EEXIST;
  915. }
  916. newclient = kzalloc(sizeof(struct smscore_client_t), GFP_KERNEL);
  917. if (!newclient) {
  918. sms_err("Failed to allocate memory for client.");
  919. return -ENOMEM;
  920. }
  921. INIT_LIST_HEAD(&newclient->idlist);
  922. newclient->coredev = coredev;
  923. newclient->onresponse_handler = params->onresponse_handler;
  924. newclient->onremove_handler = params->onremove_handler;
  925. newclient->context = params->context;
  926. list_add_locked(&newclient->entry, &coredev->clients,
  927. &coredev->clientslock);
  928. smscore_validate_client(coredev, newclient, params->data_type,
  929. params->initial_id);
  930. *client = newclient;
  931. sms_debug("%p %d %d", params->context, params->data_type,
  932. params->initial_id);
  933. return 0;
  934. }
  935. EXPORT_SYMBOL_GPL(smscore_register_client);
  936. /**
  937. * frees smsclient object and all subclients associated with it
  938. *
  939. * @param client pointer to smsclient object returned by
  940. * smscore_register_client
  941. *
  942. */
  943. void smscore_unregister_client(struct smscore_client_t *client)
  944. {
  945. struct smscore_device_t *coredev = client->coredev;
  946. unsigned long flags;
  947. spin_lock_irqsave(&coredev->clientslock, flags);
  948. while (!list_empty(&client->idlist)) {
  949. struct smscore_idlist_t *identry =
  950. (struct smscore_idlist_t *) client->idlist.next;
  951. list_del(&identry->entry);
  952. kfree(identry);
  953. }
  954. sms_info("%p", client->context);
  955. list_del(&client->entry);
  956. kfree(client);
  957. spin_unlock_irqrestore(&coredev->clientslock, flags);
  958. }
  959. EXPORT_SYMBOL_GPL(smscore_unregister_client);
  960. /**
  961. * verifies that source id is not taken by another client,
  962. * calls device handler to send requests to the device
  963. *
  964. * @param client pointer to smsclient object returned by
  965. * smscore_register_client
  966. * @param buffer pointer to a request buffer
  967. * @param size size (in bytes) of request buffer
  968. *
  969. * @return 0 on success, <0 on error.
  970. */
  971. int smsclient_sendrequest(struct smscore_client_t *client,
  972. void *buffer, size_t size)
  973. {
  974. struct smscore_device_t *coredev;
  975. struct SmsMsgHdr_ST *phdr = (struct SmsMsgHdr_ST *) buffer;
  976. int rc;
  977. if (client == NULL) {
  978. sms_err("Got NULL client");
  979. return -EINVAL;
  980. }
  981. coredev = client->coredev;
  982. /* check that no other channel with same id exists */
  983. if (coredev == NULL) {
  984. sms_err("Got NULL coredev");
  985. return -EINVAL;
  986. }
  987. rc = smscore_validate_client(client->coredev, client, 0,
  988. phdr->msgSrcId);
  989. if (rc < 0)
  990. return rc;
  991. return coredev->sendrequest_handler(coredev->context, buffer, size);
  992. }
  993. EXPORT_SYMBOL_GPL(smsclient_sendrequest);
  994. int smscore_configure_gpio(struct smscore_device_t *coredev, u32 pin,
  995. struct smscore_gpio_config *pinconfig)
  996. {
  997. struct {
  998. struct SmsMsgHdr_ST hdr;
  999. u32 data[6];
  1000. } msg;
  1001. if (coredev->device_flags & SMS_DEVICE_FAMILY2) {
  1002. msg.hdr.msgSrcId = DVBT_BDA_CONTROL_MSG_ID;
  1003. msg.hdr.msgDstId = HIF_TASK;
  1004. msg.hdr.msgFlags = 0;
  1005. msg.hdr.msgType = MSG_SMS_GPIO_CONFIG_EX_REQ;
  1006. msg.hdr.msgLength = sizeof(msg);
  1007. msg.data[0] = pin;
  1008. msg.data[1] = pinconfig->pullupdown;
  1009. /* Convert slew rate for Nova: Fast(0) = 3 / Slow(1) = 0; */
  1010. msg.data[2] = pinconfig->outputslewrate == 0 ? 3 : 0;
  1011. switch (pinconfig->outputdriving) {
  1012. case SMS_GPIO_OUTPUTDRIVING_16mA:
  1013. msg.data[3] = 7; /* Nova - 16mA */
  1014. break;
  1015. case SMS_GPIO_OUTPUTDRIVING_12mA:
  1016. msg.data[3] = 5; /* Nova - 11mA */
  1017. break;
  1018. case SMS_GPIO_OUTPUTDRIVING_8mA:
  1019. msg.data[3] = 3; /* Nova - 7mA */
  1020. break;
  1021. case SMS_GPIO_OUTPUTDRIVING_4mA:
  1022. default:
  1023. msg.data[3] = 2; /* Nova - 4mA */
  1024. break;
  1025. }
  1026. msg.data[4] = pinconfig->direction;
  1027. msg.data[5] = 0;
  1028. } else /* TODO: SMS_DEVICE_FAMILY1 */
  1029. return -EINVAL;
  1030. return coredev->sendrequest_handler(coredev->context,
  1031. &msg, sizeof(msg));
  1032. }
  1033. int smscore_set_gpio(struct smscore_device_t *coredev, u32 pin, int level)
  1034. {
  1035. struct {
  1036. struct SmsMsgHdr_ST hdr;
  1037. u32 data[3];
  1038. } msg;
  1039. if (pin > MAX_GPIO_PIN_NUMBER)
  1040. return -EINVAL;
  1041. msg.hdr.msgSrcId = DVBT_BDA_CONTROL_MSG_ID;
  1042. msg.hdr.msgDstId = HIF_TASK;
  1043. msg.hdr.msgFlags = 0;
  1044. msg.hdr.msgType = MSG_SMS_GPIO_SET_LEVEL_REQ;
  1045. msg.hdr.msgLength = sizeof(msg);
  1046. msg.data[0] = pin;
  1047. msg.data[1] = level ? 1 : 0;
  1048. msg.data[2] = 0;
  1049. return coredev->sendrequest_handler(coredev->context,
  1050. &msg, sizeof(msg));
  1051. }
  1052. static int __init smscore_module_init(void)
  1053. {
  1054. int rc = 0;
  1055. INIT_LIST_HEAD(&g_smscore_notifyees);
  1056. INIT_LIST_HEAD(&g_smscore_devices);
  1057. kmutex_init(&g_smscore_deviceslock);
  1058. INIT_LIST_HEAD(&g_smscore_registry);
  1059. kmutex_init(&g_smscore_registrylock);
  1060. return rc;
  1061. sms_debug("rc %d", rc);
  1062. return rc;
  1063. }
  1064. static void __exit smscore_module_exit(void)
  1065. {
  1066. kmutex_lock(&g_smscore_deviceslock);
  1067. while (!list_empty(&g_smscore_notifyees)) {
  1068. struct smscore_device_notifyee_t *notifyee =
  1069. (struct smscore_device_notifyee_t *)
  1070. g_smscore_notifyees.next;
  1071. list_del(&notifyee->entry);
  1072. kfree(notifyee);
  1073. }
  1074. kmutex_unlock(&g_smscore_deviceslock);
  1075. kmutex_lock(&g_smscore_registrylock);
  1076. while (!list_empty(&g_smscore_registry)) {
  1077. struct smscore_registry_entry_t *entry =
  1078. (struct smscore_registry_entry_t *)
  1079. g_smscore_registry.next;
  1080. list_del(&entry->entry);
  1081. kfree(entry);
  1082. }
  1083. kmutex_unlock(&g_smscore_registrylock);
  1084. sms_debug("");
  1085. }
  1086. module_init(smscore_module_init);
  1087. module_exit(smscore_module_exit);
  1088. MODULE_DESCRIPTION("Siano MDTV Core module");
  1089. MODULE_AUTHOR("Siano Mobile Silicon, Inc. (uris@siano-ms.com)");
  1090. MODULE_LICENSE("GPL");