smscoreapi.c 33 KB

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