radio-si470x.c 47 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770
  1. /*
  2. * drivers/media/radio/radio-si470x.c
  3. *
  4. * Driver for USB radios for the Silicon Labs Si470x FM Radio Receivers:
  5. * - Silicon Labs USB FM Radio Reference Design
  6. * - ADS/Tech FM Radio Receiver (formerly Instant FM Music) (RDX-155-EF)
  7. * - KWorld USB FM Radio SnapMusic Mobile 700 (FM700)
  8. *
  9. * Copyright (c) 2008 Tobias Lorenz <tobias.lorenz@gmx.net>
  10. *
  11. * This program is free software; you can redistribute it and/or modify
  12. * it under the terms of the GNU General Public License as published by
  13. * the Free Software Foundation; either version 2 of the License, or
  14. * (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU General Public License
  22. * along with this program; if not, write to the Free Software
  23. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  24. */
  25. /*
  26. * History:
  27. * 2008-01-12 Tobias Lorenz <tobias.lorenz@gmx.net>
  28. * Version 1.0.0
  29. * - First working version
  30. * 2008-01-13 Tobias Lorenz <tobias.lorenz@gmx.net>
  31. * Version 1.0.1
  32. * - Improved error handling, every function now returns errno
  33. * - Improved multi user access (start/mute/stop)
  34. * - Channel doesn't get lost anymore after start/mute/stop
  35. * - RDS support added (polling mode via interrupt EP 1)
  36. * - marked default module parameters with *value*
  37. * - switched from bit structs to bit masks
  38. * - header file cleaned and integrated
  39. * 2008-01-14 Tobias Lorenz <tobias.lorenz@gmx.net>
  40. * Version 1.0.2
  41. * - hex values are now lower case
  42. * - commented USB ID for ADS/Tech moved on todo list
  43. * - blacklisted si470x in hid-quirks.c
  44. * - rds buffer handling functions integrated into *_work, *_read
  45. * - rds_command in si470x_poll exchanged against simple retval
  46. * - check for firmware version 15
  47. * - code order and prototypes still remain the same
  48. * - spacing and bottom of band codes remain the same
  49. * 2008-01-16 Tobias Lorenz <tobias.lorenz@gmx.net>
  50. * Version 1.0.3
  51. * - code reordered to avoid function prototypes
  52. * - switch/case defaults are now more user-friendly
  53. * - unified comment style
  54. * - applied all checkpatch.pl v1.12 suggestions
  55. * except the warning about the too long lines with bit comments
  56. * - renamed FMRADIO to RADIO to cut line length (checkpatch.pl)
  57. * 2008-01-22 Tobias Lorenz <tobias.lorenz@gmx.net>
  58. * Version 1.0.4
  59. * - avoid poss. locking when doing copy_to_user which may sleep
  60. * - RDS is automatically activated on read now
  61. * - code cleaned of unnecessary rds_commands
  62. * - USB Vendor/Product ID for ADS/Tech FM Radio Receiver verified
  63. * (thanks to Guillaume RAMOUSSE)
  64. * 2008-01-27 Tobias Lorenz <tobias.lorenz@gmx.net>
  65. * Version 1.0.5
  66. * - number of seek_retries changed to tune_timeout
  67. * - fixed problem with incomplete tune operations by own buffers
  68. * - optimization of variables and printf types
  69. * - improved error logging
  70. * 2008-01-31 Tobias Lorenz <tobias.lorenz@gmx.net>
  71. * Oliver Neukum <oliver@neukum.org>
  72. * Version 1.0.6
  73. * - fixed coverity checker warnings in *_usb_driver_disconnect
  74. * - probe()/open() race by correct ordering in probe()
  75. * - DMA coherency rules by separate allocation of all buffers
  76. * - use of endianness macros
  77. * - abuse of spinlock, replaced by mutex
  78. * - racy handling of timer in disconnect,
  79. * replaced by delayed_work
  80. * - racy interruptible_sleep_on(),
  81. * replaced with wait_event_interruptible()
  82. * - handle signals in read()
  83. * 2008-02-08 Tobias Lorenz <tobias.lorenz@gmx.net>
  84. * Oliver Neukum <oliver@neukum.org>
  85. * Version 1.0.7
  86. * - usb autosuspend support
  87. * - unplugging fixed
  88. * 2008-05-07 Tobias Lorenz <tobias.lorenz@gmx.net>
  89. * Version 1.0.8
  90. * - hardware frequency seek support
  91. * - afc indication
  92. * - more safety checks, let si470x_get_freq return errno
  93. * - vidioc behavior corrected according to v4l2 spec
  94. * 2008-10-20 Alexey Klimov <klimov.linux@gmail.com>
  95. * - add support for KWorld USB FM Radio FM700
  96. * - blacklisted KWorld radio in hid-core.c and hid-ids.h
  97. * 2008-12-03 Mark Lord <mlord@pobox.com>
  98. * - add support for DealExtreme USB Radio
  99. *
  100. * ToDo:
  101. * - add firmware download/update support
  102. * - RDS support: interrupt mode, instead of polling
  103. * - add LED status output (check if that's not already done in firmware)
  104. */
  105. /* driver definitions */
  106. #define DRIVER_AUTHOR "Tobias Lorenz <tobias.lorenz@gmx.net>"
  107. #define DRIVER_NAME "radio-si470x"
  108. #define DRIVER_KERNEL_VERSION KERNEL_VERSION(1, 0, 8)
  109. #define DRIVER_CARD "Silicon Labs Si470x FM Radio Receiver"
  110. #define DRIVER_DESC "USB radio driver for Si470x FM Radio Receivers"
  111. #define DRIVER_VERSION "1.0.8"
  112. /* kernel includes */
  113. #include <linux/kernel.h>
  114. #include <linux/module.h>
  115. #include <linux/init.h>
  116. #include <linux/slab.h>
  117. #include <linux/input.h>
  118. #include <linux/usb.h>
  119. #include <linux/hid.h>
  120. #include <linux/version.h>
  121. #include <linux/videodev2.h>
  122. #include <linux/mutex.h>
  123. #include <media/v4l2-common.h>
  124. #include <media/v4l2-ioctl.h>
  125. #include <media/rds.h>
  126. #include <asm/unaligned.h>
  127. /* USB Device ID List */
  128. static struct usb_device_id si470x_usb_driver_id_table[] = {
  129. /* Silicon Labs USB FM Radio Reference Design */
  130. { USB_DEVICE_AND_INTERFACE_INFO(0x10c4, 0x818a, USB_CLASS_HID, 0, 0) },
  131. /* ADS/Tech FM Radio Receiver (formerly Instant FM Music) */
  132. { USB_DEVICE_AND_INTERFACE_INFO(0x06e1, 0xa155, USB_CLASS_HID, 0, 0) },
  133. /* KWorld USB FM Radio SnapMusic Mobile 700 (FM700) */
  134. { USB_DEVICE_AND_INTERFACE_INFO(0x1b80, 0xd700, USB_CLASS_HID, 0, 0) },
  135. /* DealExtreme USB Radio */
  136. { USB_DEVICE_AND_INTERFACE_INFO(0x10c5, 0x819a, USB_CLASS_HID, 0, 0) },
  137. /* Terminating entry */
  138. { }
  139. };
  140. MODULE_DEVICE_TABLE(usb, si470x_usb_driver_id_table);
  141. /**************************************************************************
  142. * Module Parameters
  143. **************************************************************************/
  144. /* Radio Nr */
  145. static int radio_nr = -1;
  146. module_param(radio_nr, int, 0444);
  147. MODULE_PARM_DESC(radio_nr, "Radio Nr");
  148. /* Spacing (kHz) */
  149. /* 0: 200 kHz (USA, Australia) */
  150. /* 1: 100 kHz (Europe, Japan) */
  151. /* 2: 50 kHz */
  152. static unsigned short space = 2;
  153. module_param(space, ushort, 0444);
  154. MODULE_PARM_DESC(space, "Spacing: 0=200kHz 1=100kHz *2=50kHz*");
  155. /* Bottom of Band (MHz) */
  156. /* 0: 87.5 - 108 MHz (USA, Europe)*/
  157. /* 1: 76 - 108 MHz (Japan wide band) */
  158. /* 2: 76 - 90 MHz (Japan) */
  159. static unsigned short band = 1;
  160. module_param(band, ushort, 0444);
  161. MODULE_PARM_DESC(band, "Band: 0=87.5..108MHz *1=76..108MHz* 2=76..90MHz");
  162. /* De-emphasis */
  163. /* 0: 75 us (USA) */
  164. /* 1: 50 us (Europe, Australia, Japan) */
  165. static unsigned short de = 1;
  166. module_param(de, ushort, 0444);
  167. MODULE_PARM_DESC(de, "De-emphasis: 0=75us *1=50us*");
  168. /* USB timeout */
  169. static unsigned int usb_timeout = 500;
  170. module_param(usb_timeout, uint, 0644);
  171. MODULE_PARM_DESC(usb_timeout, "USB timeout (ms): *500*");
  172. /* Tune timeout */
  173. static unsigned int tune_timeout = 3000;
  174. module_param(tune_timeout, uint, 0644);
  175. MODULE_PARM_DESC(tune_timeout, "Tune timeout: *3000*");
  176. /* Seek timeout */
  177. static unsigned int seek_timeout = 5000;
  178. module_param(seek_timeout, uint, 0644);
  179. MODULE_PARM_DESC(seek_timeout, "Seek timeout: *5000*");
  180. /* RDS buffer blocks */
  181. static unsigned int rds_buf = 100;
  182. module_param(rds_buf, uint, 0444);
  183. MODULE_PARM_DESC(rds_buf, "RDS buffer entries: *100*");
  184. /* RDS maximum block errors */
  185. static unsigned short max_rds_errors = 1;
  186. /* 0 means 0 errors requiring correction */
  187. /* 1 means 1-2 errors requiring correction (used by original USBRadio.exe) */
  188. /* 2 means 3-5 errors requiring correction */
  189. /* 3 means 6+ errors or errors in checkword, correction not possible */
  190. module_param(max_rds_errors, ushort, 0644);
  191. MODULE_PARM_DESC(max_rds_errors, "RDS maximum block errors: *1*");
  192. /* RDS poll frequency */
  193. static unsigned int rds_poll_time = 40;
  194. /* 40 is used by the original USBRadio.exe */
  195. /* 50 is used by radio-cadet */
  196. /* 75 should be okay */
  197. /* 80 is the usual RDS receive interval */
  198. module_param(rds_poll_time, uint, 0644);
  199. MODULE_PARM_DESC(rds_poll_time, "RDS poll time (ms): *40*");
  200. /**************************************************************************
  201. * Register Definitions
  202. **************************************************************************/
  203. #define RADIO_REGISTER_SIZE 2 /* 16 register bit width */
  204. #define RADIO_REGISTER_NUM 16 /* DEVICEID ... RDSD */
  205. #define RDS_REGISTER_NUM 6 /* STATUSRSSI ... RDSD */
  206. #define DEVICEID 0 /* Device ID */
  207. #define DEVICEID_PN 0xf000 /* bits 15..12: Part Number */
  208. #define DEVICEID_MFGID 0x0fff /* bits 11..00: Manufacturer ID */
  209. #define CHIPID 1 /* Chip ID */
  210. #define CHIPID_REV 0xfc00 /* bits 15..10: Chip Version */
  211. #define CHIPID_DEV 0x0200 /* bits 09..09: Device */
  212. #define CHIPID_FIRMWARE 0x01ff /* bits 08..00: Firmware Version */
  213. #define POWERCFG 2 /* Power Configuration */
  214. #define POWERCFG_DSMUTE 0x8000 /* bits 15..15: Softmute Disable */
  215. #define POWERCFG_DMUTE 0x4000 /* bits 14..14: Mute Disable */
  216. #define POWERCFG_MONO 0x2000 /* bits 13..13: Mono Select */
  217. #define POWERCFG_RDSM 0x0800 /* bits 11..11: RDS Mode (Si4701 only) */
  218. #define POWERCFG_SKMODE 0x0400 /* bits 10..10: Seek Mode */
  219. #define POWERCFG_SEEKUP 0x0200 /* bits 09..09: Seek Direction */
  220. #define POWERCFG_SEEK 0x0100 /* bits 08..08: Seek */
  221. #define POWERCFG_DISABLE 0x0040 /* bits 06..06: Powerup Disable */
  222. #define POWERCFG_ENABLE 0x0001 /* bits 00..00: Powerup Enable */
  223. #define CHANNEL 3 /* Channel */
  224. #define CHANNEL_TUNE 0x8000 /* bits 15..15: Tune */
  225. #define CHANNEL_CHAN 0x03ff /* bits 09..00: Channel Select */
  226. #define SYSCONFIG1 4 /* System Configuration 1 */
  227. #define SYSCONFIG1_RDSIEN 0x8000 /* bits 15..15: RDS Interrupt Enable (Si4701 only) */
  228. #define SYSCONFIG1_STCIEN 0x4000 /* bits 14..14: Seek/Tune Complete Interrupt Enable */
  229. #define SYSCONFIG1_RDS 0x1000 /* bits 12..12: RDS Enable (Si4701 only) */
  230. #define SYSCONFIG1_DE 0x0800 /* bits 11..11: De-emphasis (0=75us 1=50us) */
  231. #define SYSCONFIG1_AGCD 0x0400 /* bits 10..10: AGC Disable */
  232. #define SYSCONFIG1_BLNDADJ 0x00c0 /* bits 07..06: Stereo/Mono Blend Level Adjustment */
  233. #define SYSCONFIG1_GPIO3 0x0030 /* bits 05..04: General Purpose I/O 3 */
  234. #define SYSCONFIG1_GPIO2 0x000c /* bits 03..02: General Purpose I/O 2 */
  235. #define SYSCONFIG1_GPIO1 0x0003 /* bits 01..00: General Purpose I/O 1 */
  236. #define SYSCONFIG2 5 /* System Configuration 2 */
  237. #define SYSCONFIG2_SEEKTH 0xff00 /* bits 15..08: RSSI Seek Threshold */
  238. #define SYSCONFIG2_BAND 0x0080 /* bits 07..06: Band Select */
  239. #define SYSCONFIG2_SPACE 0x0030 /* bits 05..04: Channel Spacing */
  240. #define SYSCONFIG2_VOLUME 0x000f /* bits 03..00: Volume */
  241. #define SYSCONFIG3 6 /* System Configuration 3 */
  242. #define SYSCONFIG3_SMUTER 0xc000 /* bits 15..14: Softmute Attack/Recover Rate */
  243. #define SYSCONFIG3_SMUTEA 0x3000 /* bits 13..12: Softmute Attenuation */
  244. #define SYSCONFIG3_SKSNR 0x00f0 /* bits 07..04: Seek SNR Threshold */
  245. #define SYSCONFIG3_SKCNT 0x000f /* bits 03..00: Seek FM Impulse Detection Threshold */
  246. #define TEST1 7 /* Test 1 */
  247. #define TEST1_AHIZEN 0x4000 /* bits 14..14: Audio High-Z Enable */
  248. #define TEST2 8 /* Test 2 */
  249. /* TEST2 only contains reserved bits */
  250. #define BOOTCONFIG 9 /* Boot Configuration */
  251. /* BOOTCONFIG only contains reserved bits */
  252. #define STATUSRSSI 10 /* Status RSSI */
  253. #define STATUSRSSI_RDSR 0x8000 /* bits 15..15: RDS Ready (Si4701 only) */
  254. #define STATUSRSSI_STC 0x4000 /* bits 14..14: Seek/Tune Complete */
  255. #define STATUSRSSI_SF 0x2000 /* bits 13..13: Seek Fail/Band Limit */
  256. #define STATUSRSSI_AFCRL 0x1000 /* bits 12..12: AFC Rail */
  257. #define STATUSRSSI_RDSS 0x0800 /* bits 11..11: RDS Synchronized (Si4701 only) */
  258. #define STATUSRSSI_BLERA 0x0600 /* bits 10..09: RDS Block A Errors (Si4701 only) */
  259. #define STATUSRSSI_ST 0x0100 /* bits 08..08: Stereo Indicator */
  260. #define STATUSRSSI_RSSI 0x00ff /* bits 07..00: RSSI (Received Signal Strength Indicator) */
  261. #define READCHAN 11 /* Read Channel */
  262. #define READCHAN_BLERB 0xc000 /* bits 15..14: RDS Block D Errors (Si4701 only) */
  263. #define READCHAN_BLERC 0x3000 /* bits 13..12: RDS Block C Errors (Si4701 only) */
  264. #define READCHAN_BLERD 0x0c00 /* bits 11..10: RDS Block B Errors (Si4701 only) */
  265. #define READCHAN_READCHAN 0x03ff /* bits 09..00: Read Channel */
  266. #define RDSA 12 /* RDSA */
  267. #define RDSA_RDSA 0xffff /* bits 15..00: RDS Block A Data (Si4701 only) */
  268. #define RDSB 13 /* RDSB */
  269. #define RDSB_RDSB 0xffff /* bits 15..00: RDS Block B Data (Si4701 only) */
  270. #define RDSC 14 /* RDSC */
  271. #define RDSC_RDSC 0xffff /* bits 15..00: RDS Block C Data (Si4701 only) */
  272. #define RDSD 15 /* RDSD */
  273. #define RDSD_RDSD 0xffff /* bits 15..00: RDS Block D Data (Si4701 only) */
  274. /**************************************************************************
  275. * USB HID Reports
  276. **************************************************************************/
  277. /* Reports 1-16 give direct read/write access to the 16 Si470x registers */
  278. /* with the (REPORT_ID - 1) corresponding to the register address across USB */
  279. /* endpoint 0 using GET_REPORT and SET_REPORT */
  280. #define REGISTER_REPORT_SIZE (RADIO_REGISTER_SIZE + 1)
  281. #define REGISTER_REPORT(reg) ((reg) + 1)
  282. /* Report 17 gives direct read/write access to the entire Si470x register */
  283. /* map across endpoint 0 using GET_REPORT and SET_REPORT */
  284. #define ENTIRE_REPORT_SIZE (RADIO_REGISTER_NUM * RADIO_REGISTER_SIZE + 1)
  285. #define ENTIRE_REPORT 17
  286. /* Report 18 is used to send the lowest 6 Si470x registers up the HID */
  287. /* interrupt endpoint 1 to Windows every 20 milliseconds for status */
  288. #define RDS_REPORT_SIZE (RDS_REGISTER_NUM * RADIO_REGISTER_SIZE + 1)
  289. #define RDS_REPORT 18
  290. /* Report 19: LED state */
  291. #define LED_REPORT_SIZE 3
  292. #define LED_REPORT 19
  293. /* Report 19: stream */
  294. #define STREAM_REPORT_SIZE 3
  295. #define STREAM_REPORT 19
  296. /* Report 20: scratch */
  297. #define SCRATCH_PAGE_SIZE 63
  298. #define SCRATCH_REPORT_SIZE (SCRATCH_PAGE_SIZE + 1)
  299. #define SCRATCH_REPORT 20
  300. /* Reports 19-22: flash upgrade of the C8051F321 */
  301. #define WRITE_REPORT 19
  302. #define FLASH_REPORT 20
  303. #define CRC_REPORT 21
  304. #define RESPONSE_REPORT 22
  305. /* Report 23: currently unused, but can accept 60 byte reports on the HID */
  306. /* interrupt out endpoint 2 every 1 millisecond */
  307. #define UNUSED_REPORT 23
  308. /**************************************************************************
  309. * Software/Hardware Versions
  310. **************************************************************************/
  311. #define RADIO_SW_VERSION_NOT_BOOTLOADABLE 6
  312. #define RADIO_SW_VERSION 7
  313. #define RADIO_SW_VERSION_CURRENT 15
  314. #define RADIO_HW_VERSION 1
  315. #define SCRATCH_PAGE_SW_VERSION 1
  316. #define SCRATCH_PAGE_HW_VERSION 2
  317. /**************************************************************************
  318. * LED State Definitions
  319. **************************************************************************/
  320. #define LED_COMMAND 0x35
  321. #define NO_CHANGE_LED 0x00
  322. #define ALL_COLOR_LED 0x01 /* streaming state */
  323. #define BLINK_GREEN_LED 0x02 /* connect state */
  324. #define BLINK_RED_LED 0x04
  325. #define BLINK_ORANGE_LED 0x10 /* disconnect state */
  326. #define SOLID_GREEN_LED 0x20 /* tuning/seeking state */
  327. #define SOLID_RED_LED 0x40 /* bootload state */
  328. #define SOLID_ORANGE_LED 0x80
  329. /**************************************************************************
  330. * Stream State Definitions
  331. **************************************************************************/
  332. #define STREAM_COMMAND 0x36
  333. #define STREAM_VIDPID 0x00
  334. #define STREAM_AUDIO 0xff
  335. /**************************************************************************
  336. * Bootloader / Flash Commands
  337. **************************************************************************/
  338. /* unique id sent to bootloader and required to put into a bootload state */
  339. #define UNIQUE_BL_ID 0x34
  340. /* mask for the flash data */
  341. #define FLASH_DATA_MASK 0x55
  342. /* bootloader commands */
  343. #define GET_SW_VERSION_COMMAND 0x00
  344. #define SET_PAGE_COMMAND 0x01
  345. #define ERASE_PAGE_COMMAND 0x02
  346. #define WRITE_PAGE_COMMAND 0x03
  347. #define CRC_ON_PAGE_COMMAND 0x04
  348. #define READ_FLASH_BYTE_COMMAND 0x05
  349. #define RESET_DEVICE_COMMAND 0x06
  350. #define GET_HW_VERSION_COMMAND 0x07
  351. #define BLANK 0xff
  352. /* bootloader command responses */
  353. #define COMMAND_OK 0x01
  354. #define COMMAND_FAILED 0x02
  355. #define COMMAND_PENDING 0x03
  356. /* buffer sizes */
  357. #define COMMAND_BUFFER_SIZE 4
  358. #define RESPONSE_BUFFER_SIZE 2
  359. #define FLASH_BUFFER_SIZE 64
  360. #define CRC_BUFFER_SIZE 3
  361. /**************************************************************************
  362. * General Driver Definitions
  363. **************************************************************************/
  364. /*
  365. * si470x_device - private data
  366. */
  367. struct si470x_device {
  368. /* reference to USB and video device */
  369. struct usb_device *usbdev;
  370. struct usb_interface *intf;
  371. struct video_device *videodev;
  372. /* driver management */
  373. unsigned int users;
  374. unsigned char disconnected;
  375. struct mutex disconnect_lock;
  376. /* Silabs internal registers (0..15) */
  377. unsigned short registers[RADIO_REGISTER_NUM];
  378. /* RDS receive buffer */
  379. struct delayed_work work;
  380. wait_queue_head_t read_queue;
  381. struct mutex lock; /* buffer locking */
  382. unsigned char *buffer; /* size is always multiple of three */
  383. unsigned int buf_size;
  384. unsigned int rd_index;
  385. unsigned int wr_index;
  386. };
  387. /*
  388. * The frequency is set in units of 62.5 Hz when using V4L2_TUNER_CAP_LOW,
  389. * 62.5 kHz otherwise.
  390. * The tuner is able to have a channel spacing of 50, 100 or 200 kHz.
  391. * tuner->capability is therefore set to V4L2_TUNER_CAP_LOW
  392. * The FREQ_MUL is then: 1 MHz / 62.5 Hz = 16000
  393. */
  394. #define FREQ_MUL (1000000 / 62.5)
  395. /**************************************************************************
  396. * General Driver Functions
  397. **************************************************************************/
  398. /*
  399. * si470x_get_report - receive a HID report
  400. */
  401. static int si470x_get_report(struct si470x_device *radio, void *buf, int size)
  402. {
  403. unsigned char *report = (unsigned char *) buf;
  404. int retval;
  405. retval = usb_control_msg(radio->usbdev,
  406. usb_rcvctrlpipe(radio->usbdev, 0),
  407. HID_REQ_GET_REPORT,
  408. USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_IN,
  409. report[0], 2,
  410. buf, size, usb_timeout);
  411. if (retval < 0)
  412. printk(KERN_WARNING DRIVER_NAME
  413. ": si470x_get_report: usb_control_msg returned %d\n",
  414. retval);
  415. return retval;
  416. }
  417. /*
  418. * si470x_set_report - send a HID report
  419. */
  420. static int si470x_set_report(struct si470x_device *radio, void *buf, int size)
  421. {
  422. unsigned char *report = (unsigned char *) buf;
  423. int retval;
  424. retval = usb_control_msg(radio->usbdev,
  425. usb_sndctrlpipe(radio->usbdev, 0),
  426. HID_REQ_SET_REPORT,
  427. USB_TYPE_CLASS | USB_RECIP_INTERFACE | USB_DIR_OUT,
  428. report[0], 2,
  429. buf, size, usb_timeout);
  430. if (retval < 0)
  431. printk(KERN_WARNING DRIVER_NAME
  432. ": si470x_set_report: usb_control_msg returned %d\n",
  433. retval);
  434. return retval;
  435. }
  436. /*
  437. * si470x_get_register - read register
  438. */
  439. static int si470x_get_register(struct si470x_device *radio, int regnr)
  440. {
  441. unsigned char buf[REGISTER_REPORT_SIZE];
  442. int retval;
  443. buf[0] = REGISTER_REPORT(regnr);
  444. retval = si470x_get_report(radio, (void *) &buf, sizeof(buf));
  445. if (retval >= 0)
  446. radio->registers[regnr] = get_unaligned_be16(&buf[1]);
  447. return (retval < 0) ? -EINVAL : 0;
  448. }
  449. /*
  450. * si470x_set_register - write register
  451. */
  452. static int si470x_set_register(struct si470x_device *radio, int regnr)
  453. {
  454. unsigned char buf[REGISTER_REPORT_SIZE];
  455. int retval;
  456. buf[0] = REGISTER_REPORT(regnr);
  457. put_unaligned_be16(radio->registers[regnr], &buf[1]);
  458. retval = si470x_set_report(radio, (void *) &buf, sizeof(buf));
  459. return (retval < 0) ? -EINVAL : 0;
  460. }
  461. /*
  462. * si470x_get_all_registers - read entire registers
  463. */
  464. static int si470x_get_all_registers(struct si470x_device *radio)
  465. {
  466. unsigned char buf[ENTIRE_REPORT_SIZE];
  467. int retval;
  468. unsigned char regnr;
  469. buf[0] = ENTIRE_REPORT;
  470. retval = si470x_get_report(radio, (void *) &buf, sizeof(buf));
  471. if (retval >= 0)
  472. for (regnr = 0; regnr < RADIO_REGISTER_NUM; regnr++)
  473. radio->registers[regnr] = get_unaligned_be16(
  474. &buf[regnr * RADIO_REGISTER_SIZE + 1]);
  475. return (retval < 0) ? -EINVAL : 0;
  476. }
  477. /*
  478. * si470x_get_rds_registers - read rds registers
  479. */
  480. static int si470x_get_rds_registers(struct si470x_device *radio)
  481. {
  482. unsigned char buf[RDS_REPORT_SIZE];
  483. int retval;
  484. int size;
  485. unsigned char regnr;
  486. buf[0] = RDS_REPORT;
  487. retval = usb_interrupt_msg(radio->usbdev,
  488. usb_rcvintpipe(radio->usbdev, 1),
  489. (void *) &buf, sizeof(buf), &size, usb_timeout);
  490. if (size != sizeof(buf))
  491. printk(KERN_WARNING DRIVER_NAME ": si470x_get_rds_registers: "
  492. "return size differs: %d != %zu\n", size, sizeof(buf));
  493. if (retval < 0)
  494. printk(KERN_WARNING DRIVER_NAME ": si470x_get_rds_registers: "
  495. "usb_interrupt_msg returned %d\n", retval);
  496. if (retval >= 0)
  497. for (regnr = 0; regnr < RDS_REGISTER_NUM; regnr++)
  498. radio->registers[STATUSRSSI + regnr] =
  499. get_unaligned_be16(
  500. &buf[regnr * RADIO_REGISTER_SIZE + 1]);
  501. return (retval < 0) ? -EINVAL : 0;
  502. }
  503. /*
  504. * si470x_set_chan - set the channel
  505. */
  506. static int si470x_set_chan(struct si470x_device *radio, unsigned short chan)
  507. {
  508. int retval;
  509. unsigned long timeout;
  510. bool timed_out = 0;
  511. /* start tuning */
  512. radio->registers[CHANNEL] &= ~CHANNEL_CHAN;
  513. radio->registers[CHANNEL] |= CHANNEL_TUNE | chan;
  514. retval = si470x_set_register(radio, CHANNEL);
  515. if (retval < 0)
  516. goto done;
  517. /* wait till tune operation has completed */
  518. timeout = jiffies + msecs_to_jiffies(tune_timeout);
  519. do {
  520. retval = si470x_get_register(radio, STATUSRSSI);
  521. if (retval < 0)
  522. goto stop;
  523. timed_out = time_after(jiffies, timeout);
  524. } while (((radio->registers[STATUSRSSI] & STATUSRSSI_STC) == 0) &&
  525. (!timed_out));
  526. if ((radio->registers[STATUSRSSI] & STATUSRSSI_STC) == 0)
  527. printk(KERN_WARNING DRIVER_NAME ": tune does not complete\n");
  528. if (timed_out)
  529. printk(KERN_WARNING DRIVER_NAME
  530. ": tune timed out after %u ms\n", tune_timeout);
  531. stop:
  532. /* stop tuning */
  533. radio->registers[CHANNEL] &= ~CHANNEL_TUNE;
  534. retval = si470x_set_register(radio, CHANNEL);
  535. done:
  536. return retval;
  537. }
  538. /*
  539. * si470x_get_freq - get the frequency
  540. */
  541. static int si470x_get_freq(struct si470x_device *radio, unsigned int *freq)
  542. {
  543. unsigned int spacing, band_bottom;
  544. unsigned short chan;
  545. int retval;
  546. /* Spacing (kHz) */
  547. switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_SPACE) >> 4) {
  548. /* 0: 200 kHz (USA, Australia) */
  549. case 0:
  550. spacing = 0.200 * FREQ_MUL; break;
  551. /* 1: 100 kHz (Europe, Japan) */
  552. case 1:
  553. spacing = 0.100 * FREQ_MUL; break;
  554. /* 2: 50 kHz */
  555. default:
  556. spacing = 0.050 * FREQ_MUL; break;
  557. };
  558. /* Bottom of Band (MHz) */
  559. switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_BAND) >> 6) {
  560. /* 0: 87.5 - 108 MHz (USA, Europe) */
  561. case 0:
  562. band_bottom = 87.5 * FREQ_MUL; break;
  563. /* 1: 76 - 108 MHz (Japan wide band) */
  564. default:
  565. band_bottom = 76 * FREQ_MUL; break;
  566. /* 2: 76 - 90 MHz (Japan) */
  567. case 2:
  568. band_bottom = 76 * FREQ_MUL; break;
  569. };
  570. /* read channel */
  571. retval = si470x_get_register(radio, READCHAN);
  572. chan = radio->registers[READCHAN] & READCHAN_READCHAN;
  573. /* Frequency (MHz) = Spacing (kHz) x Channel + Bottom of Band (MHz) */
  574. *freq = chan * spacing + band_bottom;
  575. return retval;
  576. }
  577. /*
  578. * si470x_set_freq - set the frequency
  579. */
  580. static int si470x_set_freq(struct si470x_device *radio, unsigned int freq)
  581. {
  582. unsigned int spacing, band_bottom;
  583. unsigned short chan;
  584. /* Spacing (kHz) */
  585. switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_SPACE) >> 4) {
  586. /* 0: 200 kHz (USA, Australia) */
  587. case 0:
  588. spacing = 0.200 * FREQ_MUL; break;
  589. /* 1: 100 kHz (Europe, Japan) */
  590. case 1:
  591. spacing = 0.100 * FREQ_MUL; break;
  592. /* 2: 50 kHz */
  593. default:
  594. spacing = 0.050 * FREQ_MUL; break;
  595. };
  596. /* Bottom of Band (MHz) */
  597. switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_BAND) >> 6) {
  598. /* 0: 87.5 - 108 MHz (USA, Europe) */
  599. case 0:
  600. band_bottom = 87.5 * FREQ_MUL; break;
  601. /* 1: 76 - 108 MHz (Japan wide band) */
  602. default:
  603. band_bottom = 76 * FREQ_MUL; break;
  604. /* 2: 76 - 90 MHz (Japan) */
  605. case 2:
  606. band_bottom = 76 * FREQ_MUL; break;
  607. };
  608. /* Chan = [ Freq (Mhz) - Bottom of Band (MHz) ] / Spacing (kHz) */
  609. chan = (freq - band_bottom) / spacing;
  610. return si470x_set_chan(radio, chan);
  611. }
  612. /*
  613. * si470x_set_seek - set seek
  614. */
  615. static int si470x_set_seek(struct si470x_device *radio,
  616. unsigned int wrap_around, unsigned int seek_upward)
  617. {
  618. int retval = 0;
  619. unsigned long timeout;
  620. bool timed_out = 0;
  621. /* start seeking */
  622. radio->registers[POWERCFG] |= POWERCFG_SEEK;
  623. if (wrap_around == 1)
  624. radio->registers[POWERCFG] &= ~POWERCFG_SKMODE;
  625. else
  626. radio->registers[POWERCFG] |= POWERCFG_SKMODE;
  627. if (seek_upward == 1)
  628. radio->registers[POWERCFG] |= POWERCFG_SEEKUP;
  629. else
  630. radio->registers[POWERCFG] &= ~POWERCFG_SEEKUP;
  631. retval = si470x_set_register(radio, POWERCFG);
  632. if (retval < 0)
  633. goto done;
  634. /* wait till seek operation has completed */
  635. timeout = jiffies + msecs_to_jiffies(seek_timeout);
  636. do {
  637. retval = si470x_get_register(radio, STATUSRSSI);
  638. if (retval < 0)
  639. goto stop;
  640. timed_out = time_after(jiffies, timeout);
  641. } while (((radio->registers[STATUSRSSI] & STATUSRSSI_STC) == 0) &&
  642. (!timed_out));
  643. if ((radio->registers[STATUSRSSI] & STATUSRSSI_STC) == 0)
  644. printk(KERN_WARNING DRIVER_NAME ": seek does not complete\n");
  645. if (radio->registers[STATUSRSSI] & STATUSRSSI_SF)
  646. printk(KERN_WARNING DRIVER_NAME
  647. ": seek failed / band limit reached\n");
  648. if (timed_out)
  649. printk(KERN_WARNING DRIVER_NAME
  650. ": seek timed out after %u ms\n", seek_timeout);
  651. stop:
  652. /* stop seeking */
  653. radio->registers[POWERCFG] &= ~POWERCFG_SEEK;
  654. retval = si470x_set_register(radio, POWERCFG);
  655. done:
  656. /* try again, if timed out */
  657. if ((retval == 0) && timed_out)
  658. retval = -EAGAIN;
  659. return retval;
  660. }
  661. /*
  662. * si470x_start - switch on radio
  663. */
  664. static int si470x_start(struct si470x_device *radio)
  665. {
  666. int retval;
  667. /* powercfg */
  668. radio->registers[POWERCFG] =
  669. POWERCFG_DMUTE | POWERCFG_ENABLE | POWERCFG_RDSM;
  670. retval = si470x_set_register(radio, POWERCFG);
  671. if (retval < 0)
  672. goto done;
  673. /* sysconfig 1 */
  674. radio->registers[SYSCONFIG1] = SYSCONFIG1_DE;
  675. retval = si470x_set_register(radio, SYSCONFIG1);
  676. if (retval < 0)
  677. goto done;
  678. /* sysconfig 2 */
  679. radio->registers[SYSCONFIG2] =
  680. (0x3f << 8) | /* SEEKTH */
  681. ((band << 6) & SYSCONFIG2_BAND) | /* BAND */
  682. ((space << 4) & SYSCONFIG2_SPACE) | /* SPACE */
  683. 15; /* VOLUME (max) */
  684. retval = si470x_set_register(radio, SYSCONFIG2);
  685. if (retval < 0)
  686. goto done;
  687. /* reset last channel */
  688. retval = si470x_set_chan(radio,
  689. radio->registers[CHANNEL] & CHANNEL_CHAN);
  690. done:
  691. return retval;
  692. }
  693. /*
  694. * si470x_stop - switch off radio
  695. */
  696. static int si470x_stop(struct si470x_device *radio)
  697. {
  698. int retval;
  699. /* sysconfig 1 */
  700. radio->registers[SYSCONFIG1] &= ~SYSCONFIG1_RDS;
  701. retval = si470x_set_register(radio, SYSCONFIG1);
  702. if (retval < 0)
  703. goto done;
  704. /* powercfg */
  705. radio->registers[POWERCFG] &= ~POWERCFG_DMUTE;
  706. /* POWERCFG_ENABLE has to automatically go low */
  707. radio->registers[POWERCFG] |= POWERCFG_ENABLE | POWERCFG_DISABLE;
  708. retval = si470x_set_register(radio, POWERCFG);
  709. done:
  710. return retval;
  711. }
  712. /*
  713. * si470x_rds_on - switch on rds reception
  714. */
  715. static int si470x_rds_on(struct si470x_device *radio)
  716. {
  717. int retval;
  718. /* sysconfig 1 */
  719. mutex_lock(&radio->lock);
  720. radio->registers[SYSCONFIG1] |= SYSCONFIG1_RDS;
  721. retval = si470x_set_register(radio, SYSCONFIG1);
  722. if (retval < 0)
  723. radio->registers[SYSCONFIG1] &= ~SYSCONFIG1_RDS;
  724. mutex_unlock(&radio->lock);
  725. return retval;
  726. }
  727. /**************************************************************************
  728. * RDS Driver Functions
  729. **************************************************************************/
  730. /*
  731. * si470x_rds - rds processing function
  732. */
  733. static void si470x_rds(struct si470x_device *radio)
  734. {
  735. unsigned char blocknum;
  736. unsigned short bler; /* rds block errors */
  737. unsigned short rds;
  738. unsigned char tmpbuf[3];
  739. /* get rds blocks */
  740. if (si470x_get_rds_registers(radio) < 0)
  741. return;
  742. if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSR) == 0) {
  743. /* No RDS group ready */
  744. return;
  745. }
  746. if ((radio->registers[STATUSRSSI] & STATUSRSSI_RDSS) == 0) {
  747. /* RDS decoder not synchronized */
  748. return;
  749. }
  750. /* copy all four RDS blocks to internal buffer */
  751. mutex_lock(&radio->lock);
  752. for (blocknum = 0; blocknum < 4; blocknum++) {
  753. switch (blocknum) {
  754. default:
  755. bler = (radio->registers[STATUSRSSI] &
  756. STATUSRSSI_BLERA) >> 9;
  757. rds = radio->registers[RDSA];
  758. break;
  759. case 1:
  760. bler = (radio->registers[READCHAN] &
  761. READCHAN_BLERB) >> 14;
  762. rds = radio->registers[RDSB];
  763. break;
  764. case 2:
  765. bler = (radio->registers[READCHAN] &
  766. READCHAN_BLERC) >> 12;
  767. rds = radio->registers[RDSC];
  768. break;
  769. case 3:
  770. bler = (radio->registers[READCHAN] &
  771. READCHAN_BLERD) >> 10;
  772. rds = radio->registers[RDSD];
  773. break;
  774. };
  775. /* Fill the V4L2 RDS buffer */
  776. put_unaligned_le16(rds, &tmpbuf);
  777. tmpbuf[2] = blocknum; /* offset name */
  778. tmpbuf[2] |= blocknum << 3; /* received offset */
  779. if (bler > max_rds_errors)
  780. tmpbuf[2] |= 0x80; /* uncorrectable errors */
  781. else if (bler > 0)
  782. tmpbuf[2] |= 0x40; /* corrected error(s) */
  783. /* copy RDS block to internal buffer */
  784. memcpy(&radio->buffer[radio->wr_index], &tmpbuf, 3);
  785. radio->wr_index += 3;
  786. /* wrap write pointer */
  787. if (radio->wr_index >= radio->buf_size)
  788. radio->wr_index = 0;
  789. /* check for overflow */
  790. if (radio->wr_index == radio->rd_index) {
  791. /* increment and wrap read pointer */
  792. radio->rd_index += 3;
  793. if (radio->rd_index >= radio->buf_size)
  794. radio->rd_index = 0;
  795. }
  796. }
  797. mutex_unlock(&radio->lock);
  798. /* wake up read queue */
  799. if (radio->wr_index != radio->rd_index)
  800. wake_up_interruptible(&radio->read_queue);
  801. }
  802. /*
  803. * si470x_work - rds work function
  804. */
  805. static void si470x_work(struct work_struct *work)
  806. {
  807. struct si470x_device *radio = container_of(work, struct si470x_device,
  808. work.work);
  809. /* safety checks */
  810. if (radio->disconnected)
  811. return;
  812. if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS) == 0)
  813. return;
  814. si470x_rds(radio);
  815. schedule_delayed_work(&radio->work, msecs_to_jiffies(rds_poll_time));
  816. }
  817. /**************************************************************************
  818. * File Operations Interface
  819. **************************************************************************/
  820. /*
  821. * si470x_fops_read - read RDS data
  822. */
  823. static ssize_t si470x_fops_read(struct file *file, char __user *buf,
  824. size_t count, loff_t *ppos)
  825. {
  826. struct si470x_device *radio = video_drvdata(file);
  827. int retval = 0;
  828. unsigned int block_count = 0;
  829. /* switch on rds reception */
  830. if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS) == 0) {
  831. si470x_rds_on(radio);
  832. schedule_delayed_work(&radio->work,
  833. msecs_to_jiffies(rds_poll_time));
  834. }
  835. /* block if no new data available */
  836. while (radio->wr_index == radio->rd_index) {
  837. if (file->f_flags & O_NONBLOCK) {
  838. retval = -EWOULDBLOCK;
  839. goto done;
  840. }
  841. if (wait_event_interruptible(radio->read_queue,
  842. radio->wr_index != radio->rd_index) < 0) {
  843. retval = -EINTR;
  844. goto done;
  845. }
  846. }
  847. /* calculate block count from byte count */
  848. count /= 3;
  849. /* copy RDS block out of internal buffer and to user buffer */
  850. mutex_lock(&radio->lock);
  851. while (block_count < count) {
  852. if (radio->rd_index == radio->wr_index)
  853. break;
  854. /* always transfer rds complete blocks */
  855. if (copy_to_user(buf, &radio->buffer[radio->rd_index], 3))
  856. /* retval = -EFAULT; */
  857. break;
  858. /* increment and wrap read pointer */
  859. radio->rd_index += 3;
  860. if (radio->rd_index >= radio->buf_size)
  861. radio->rd_index = 0;
  862. /* increment counters */
  863. block_count++;
  864. buf += 3;
  865. retval += 3;
  866. }
  867. mutex_unlock(&radio->lock);
  868. done:
  869. return retval;
  870. }
  871. /*
  872. * si470x_fops_poll - poll RDS data
  873. */
  874. static unsigned int si470x_fops_poll(struct file *file,
  875. struct poll_table_struct *pts)
  876. {
  877. struct si470x_device *radio = video_drvdata(file);
  878. int retval = 0;
  879. /* switch on rds reception */
  880. if ((radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS) == 0) {
  881. si470x_rds_on(radio);
  882. schedule_delayed_work(&radio->work,
  883. msecs_to_jiffies(rds_poll_time));
  884. }
  885. poll_wait(file, &radio->read_queue, pts);
  886. if (radio->rd_index != radio->wr_index)
  887. retval = POLLIN | POLLRDNORM;
  888. return retval;
  889. }
  890. /*
  891. * si470x_fops_open - file open
  892. */
  893. static int si470x_fops_open(struct file *file)
  894. {
  895. struct si470x_device *radio = video_drvdata(file);
  896. int retval;
  897. lock_kernel();
  898. radio->users++;
  899. retval = usb_autopm_get_interface(radio->intf);
  900. if (retval < 0) {
  901. radio->users--;
  902. retval = -EIO;
  903. goto done;
  904. }
  905. if (radio->users == 1) {
  906. retval = si470x_start(radio);
  907. if (retval < 0)
  908. usb_autopm_put_interface(radio->intf);
  909. }
  910. done:
  911. unlock_kernel();
  912. return retval;
  913. }
  914. /*
  915. * si470x_fops_release - file release
  916. */
  917. static int si470x_fops_release(struct file *file)
  918. {
  919. struct si470x_device *radio = video_drvdata(file);
  920. int retval = 0;
  921. /* safety check */
  922. if (!radio) {
  923. retval = -ENODEV;
  924. goto done;
  925. }
  926. mutex_lock(&radio->disconnect_lock);
  927. radio->users--;
  928. if (radio->users == 0) {
  929. if (radio->disconnected) {
  930. video_unregister_device(radio->videodev);
  931. kfree(radio->buffer);
  932. kfree(radio);
  933. goto unlock;
  934. }
  935. /* stop rds reception */
  936. cancel_delayed_work_sync(&radio->work);
  937. /* cancel read processes */
  938. wake_up_interruptible(&radio->read_queue);
  939. retval = si470x_stop(radio);
  940. usb_autopm_put_interface(radio->intf);
  941. }
  942. unlock:
  943. mutex_unlock(&radio->disconnect_lock);
  944. done:
  945. return retval;
  946. }
  947. /*
  948. * si470x_fops - file operations interface
  949. */
  950. static const struct v4l2_file_operations si470x_fops = {
  951. .owner = THIS_MODULE,
  952. .read = si470x_fops_read,
  953. .poll = si470x_fops_poll,
  954. .ioctl = video_ioctl2,
  955. .open = si470x_fops_open,
  956. .release = si470x_fops_release,
  957. };
  958. /**************************************************************************
  959. * Video4Linux Interface
  960. **************************************************************************/
  961. /*
  962. * si470x_v4l2_queryctrl - query control
  963. */
  964. static struct v4l2_queryctrl si470x_v4l2_queryctrl[] = {
  965. {
  966. .id = V4L2_CID_AUDIO_VOLUME,
  967. .type = V4L2_CTRL_TYPE_INTEGER,
  968. .name = "Volume",
  969. .minimum = 0,
  970. .maximum = 15,
  971. .step = 1,
  972. .default_value = 15,
  973. },
  974. {
  975. .id = V4L2_CID_AUDIO_MUTE,
  976. .type = V4L2_CTRL_TYPE_BOOLEAN,
  977. .name = "Mute",
  978. .minimum = 0,
  979. .maximum = 1,
  980. .step = 1,
  981. .default_value = 1,
  982. },
  983. };
  984. /*
  985. * si470x_vidioc_querycap - query device capabilities
  986. */
  987. static int si470x_vidioc_querycap(struct file *file, void *priv,
  988. struct v4l2_capability *capability)
  989. {
  990. strlcpy(capability->driver, DRIVER_NAME, sizeof(capability->driver));
  991. strlcpy(capability->card, DRIVER_CARD, sizeof(capability->card));
  992. sprintf(capability->bus_info, "USB");
  993. capability->version = DRIVER_KERNEL_VERSION;
  994. capability->capabilities = V4L2_CAP_HW_FREQ_SEEK |
  995. V4L2_CAP_TUNER | V4L2_CAP_RADIO;
  996. return 0;
  997. }
  998. /*
  999. * si470x_vidioc_queryctrl - enumerate control items
  1000. */
  1001. static int si470x_vidioc_queryctrl(struct file *file, void *priv,
  1002. struct v4l2_queryctrl *qc)
  1003. {
  1004. unsigned char i = 0;
  1005. int retval = -EINVAL;
  1006. /* abort if qc->id is below V4L2_CID_BASE */
  1007. if (qc->id < V4L2_CID_BASE)
  1008. goto done;
  1009. /* search video control */
  1010. for (i = 0; i < ARRAY_SIZE(si470x_v4l2_queryctrl); i++) {
  1011. if (qc->id == si470x_v4l2_queryctrl[i].id) {
  1012. memcpy(qc, &(si470x_v4l2_queryctrl[i]), sizeof(*qc));
  1013. retval = 0; /* found */
  1014. break;
  1015. }
  1016. }
  1017. /* disable unsupported base controls */
  1018. /* to satisfy kradio and such apps */
  1019. if ((retval == -EINVAL) && (qc->id < V4L2_CID_LASTP1)) {
  1020. qc->flags = V4L2_CTRL_FLAG_DISABLED;
  1021. retval = 0;
  1022. }
  1023. done:
  1024. if (retval < 0)
  1025. printk(KERN_WARNING DRIVER_NAME
  1026. ": query controls failed with %d\n", retval);
  1027. return retval;
  1028. }
  1029. /*
  1030. * si470x_vidioc_g_ctrl - get the value of a control
  1031. */
  1032. static int si470x_vidioc_g_ctrl(struct file *file, void *priv,
  1033. struct v4l2_control *ctrl)
  1034. {
  1035. struct si470x_device *radio = video_drvdata(file);
  1036. int retval = 0;
  1037. /* safety checks */
  1038. if (radio->disconnected) {
  1039. retval = -EIO;
  1040. goto done;
  1041. }
  1042. switch (ctrl->id) {
  1043. case V4L2_CID_AUDIO_VOLUME:
  1044. ctrl->value = radio->registers[SYSCONFIG2] &
  1045. SYSCONFIG2_VOLUME;
  1046. break;
  1047. case V4L2_CID_AUDIO_MUTE:
  1048. ctrl->value = ((radio->registers[POWERCFG] &
  1049. POWERCFG_DMUTE) == 0) ? 1 : 0;
  1050. break;
  1051. default:
  1052. retval = -EINVAL;
  1053. }
  1054. done:
  1055. if (retval < 0)
  1056. printk(KERN_WARNING DRIVER_NAME
  1057. ": get control failed with %d\n", retval);
  1058. return retval;
  1059. }
  1060. /*
  1061. * si470x_vidioc_s_ctrl - set the value of a control
  1062. */
  1063. static int si470x_vidioc_s_ctrl(struct file *file, void *priv,
  1064. struct v4l2_control *ctrl)
  1065. {
  1066. struct si470x_device *radio = video_drvdata(file);
  1067. int retval = 0;
  1068. /* safety checks */
  1069. if (radio->disconnected) {
  1070. retval = -EIO;
  1071. goto done;
  1072. }
  1073. switch (ctrl->id) {
  1074. case V4L2_CID_AUDIO_VOLUME:
  1075. radio->registers[SYSCONFIG2] &= ~SYSCONFIG2_VOLUME;
  1076. radio->registers[SYSCONFIG2] |= ctrl->value;
  1077. retval = si470x_set_register(radio, SYSCONFIG2);
  1078. break;
  1079. case V4L2_CID_AUDIO_MUTE:
  1080. if (ctrl->value == 1)
  1081. radio->registers[POWERCFG] &= ~POWERCFG_DMUTE;
  1082. else
  1083. radio->registers[POWERCFG] |= POWERCFG_DMUTE;
  1084. retval = si470x_set_register(radio, POWERCFG);
  1085. break;
  1086. default:
  1087. retval = -EINVAL;
  1088. }
  1089. done:
  1090. if (retval < 0)
  1091. printk(KERN_WARNING DRIVER_NAME
  1092. ": set control failed with %d\n", retval);
  1093. return retval;
  1094. }
  1095. /*
  1096. * si470x_vidioc_g_audio - get audio attributes
  1097. */
  1098. static int si470x_vidioc_g_audio(struct file *file, void *priv,
  1099. struct v4l2_audio *audio)
  1100. {
  1101. /* driver constants */
  1102. audio->index = 0;
  1103. strcpy(audio->name, "Radio");
  1104. audio->capability = V4L2_AUDCAP_STEREO;
  1105. audio->mode = 0;
  1106. return 0;
  1107. }
  1108. /*
  1109. * si470x_vidioc_g_tuner - get tuner attributes
  1110. */
  1111. static int si470x_vidioc_g_tuner(struct file *file, void *priv,
  1112. struct v4l2_tuner *tuner)
  1113. {
  1114. struct si470x_device *radio = video_drvdata(file);
  1115. int retval = 0;
  1116. /* safety checks */
  1117. if (radio->disconnected) {
  1118. retval = -EIO;
  1119. goto done;
  1120. }
  1121. if (tuner->index != 0) {
  1122. retval = -EINVAL;
  1123. goto done;
  1124. }
  1125. retval = si470x_get_register(radio, STATUSRSSI);
  1126. if (retval < 0)
  1127. goto done;
  1128. /* driver constants */
  1129. strcpy(tuner->name, "FM");
  1130. tuner->type = V4L2_TUNER_RADIO;
  1131. tuner->capability = V4L2_TUNER_CAP_LOW | V4L2_TUNER_CAP_STEREO;
  1132. /* range limits */
  1133. switch ((radio->registers[SYSCONFIG2] & SYSCONFIG2_BAND) >> 6) {
  1134. /* 0: 87.5 - 108 MHz (USA, Europe, default) */
  1135. default:
  1136. tuner->rangelow = 87.5 * FREQ_MUL;
  1137. tuner->rangehigh = 108 * FREQ_MUL;
  1138. break;
  1139. /* 1: 76 - 108 MHz (Japan wide band) */
  1140. case 1 :
  1141. tuner->rangelow = 76 * FREQ_MUL;
  1142. tuner->rangehigh = 108 * FREQ_MUL;
  1143. break;
  1144. /* 2: 76 - 90 MHz (Japan) */
  1145. case 2 :
  1146. tuner->rangelow = 76 * FREQ_MUL;
  1147. tuner->rangehigh = 90 * FREQ_MUL;
  1148. break;
  1149. };
  1150. /* stereo indicator == stereo (instead of mono) */
  1151. if ((radio->registers[STATUSRSSI] & STATUSRSSI_ST) == 1)
  1152. tuner->rxsubchans = V4L2_TUNER_SUB_MONO | V4L2_TUNER_SUB_STEREO;
  1153. else
  1154. tuner->rxsubchans = V4L2_TUNER_SUB_MONO;
  1155. /* mono/stereo selector */
  1156. if ((radio->registers[POWERCFG] & POWERCFG_MONO) == 1)
  1157. tuner->audmode = V4L2_TUNER_MODE_MONO;
  1158. else
  1159. tuner->audmode = V4L2_TUNER_MODE_STEREO;
  1160. /* min is worst, max is best; signal:0..0xffff; rssi: 0..0xff */
  1161. tuner->signal = (radio->registers[STATUSRSSI] & STATUSRSSI_RSSI)
  1162. * 0x0101;
  1163. /* automatic frequency control: -1: freq to low, 1 freq to high */
  1164. /* AFCRL does only indicate that freq. differs, not if too low/high */
  1165. tuner->afc = (radio->registers[STATUSRSSI] & STATUSRSSI_AFCRL) ? 1 : 0;
  1166. done:
  1167. if (retval < 0)
  1168. printk(KERN_WARNING DRIVER_NAME
  1169. ": get tuner failed with %d\n", retval);
  1170. return retval;
  1171. }
  1172. /*
  1173. * si470x_vidioc_s_tuner - set tuner attributes
  1174. */
  1175. static int si470x_vidioc_s_tuner(struct file *file, void *priv,
  1176. struct v4l2_tuner *tuner)
  1177. {
  1178. struct si470x_device *radio = video_drvdata(file);
  1179. int retval = -EINVAL;
  1180. /* safety checks */
  1181. if (radio->disconnected) {
  1182. retval = -EIO;
  1183. goto done;
  1184. }
  1185. if (tuner->index != 0)
  1186. goto done;
  1187. /* mono/stereo selector */
  1188. switch (tuner->audmode) {
  1189. case V4L2_TUNER_MODE_MONO:
  1190. radio->registers[POWERCFG] |= POWERCFG_MONO; /* force mono */
  1191. break;
  1192. case V4L2_TUNER_MODE_STEREO:
  1193. radio->registers[POWERCFG] &= ~POWERCFG_MONO; /* try stereo */
  1194. break;
  1195. default:
  1196. goto done;
  1197. }
  1198. retval = si470x_set_register(radio, POWERCFG);
  1199. done:
  1200. if (retval < 0)
  1201. printk(KERN_WARNING DRIVER_NAME
  1202. ": set tuner failed with %d\n", retval);
  1203. return retval;
  1204. }
  1205. /*
  1206. * si470x_vidioc_g_frequency - get tuner or modulator radio frequency
  1207. */
  1208. static int si470x_vidioc_g_frequency(struct file *file, void *priv,
  1209. struct v4l2_frequency *freq)
  1210. {
  1211. struct si470x_device *radio = video_drvdata(file);
  1212. int retval = 0;
  1213. /* safety checks */
  1214. if (radio->disconnected) {
  1215. retval = -EIO;
  1216. goto done;
  1217. }
  1218. if (freq->tuner != 0) {
  1219. retval = -EINVAL;
  1220. goto done;
  1221. }
  1222. freq->type = V4L2_TUNER_RADIO;
  1223. retval = si470x_get_freq(radio, &freq->frequency);
  1224. done:
  1225. if (retval < 0)
  1226. printk(KERN_WARNING DRIVER_NAME
  1227. ": get frequency failed with %d\n", retval);
  1228. return retval;
  1229. }
  1230. /*
  1231. * si470x_vidioc_s_frequency - set tuner or modulator radio frequency
  1232. */
  1233. static int si470x_vidioc_s_frequency(struct file *file, void *priv,
  1234. struct v4l2_frequency *freq)
  1235. {
  1236. struct si470x_device *radio = video_drvdata(file);
  1237. int retval = 0;
  1238. /* safety checks */
  1239. if (radio->disconnected) {
  1240. retval = -EIO;
  1241. goto done;
  1242. }
  1243. if (freq->tuner != 0) {
  1244. retval = -EINVAL;
  1245. goto done;
  1246. }
  1247. retval = si470x_set_freq(radio, freq->frequency);
  1248. done:
  1249. if (retval < 0)
  1250. printk(KERN_WARNING DRIVER_NAME
  1251. ": set frequency failed with %d\n", retval);
  1252. return retval;
  1253. }
  1254. /*
  1255. * si470x_vidioc_s_hw_freq_seek - set hardware frequency seek
  1256. */
  1257. static int si470x_vidioc_s_hw_freq_seek(struct file *file, void *priv,
  1258. struct v4l2_hw_freq_seek *seek)
  1259. {
  1260. struct si470x_device *radio = video_drvdata(file);
  1261. int retval = 0;
  1262. /* safety checks */
  1263. if (radio->disconnected) {
  1264. retval = -EIO;
  1265. goto done;
  1266. }
  1267. if (seek->tuner != 0) {
  1268. retval = -EINVAL;
  1269. goto done;
  1270. }
  1271. retval = si470x_set_seek(radio, seek->wrap_around, seek->seek_upward);
  1272. done:
  1273. if (retval < 0)
  1274. printk(KERN_WARNING DRIVER_NAME
  1275. ": set hardware frequency seek failed with %d\n",
  1276. retval);
  1277. return retval;
  1278. }
  1279. /*
  1280. * si470x_ioctl_ops - video device ioctl operations
  1281. */
  1282. static const struct v4l2_ioctl_ops si470x_ioctl_ops = {
  1283. .vidioc_querycap = si470x_vidioc_querycap,
  1284. .vidioc_queryctrl = si470x_vidioc_queryctrl,
  1285. .vidioc_g_ctrl = si470x_vidioc_g_ctrl,
  1286. .vidioc_s_ctrl = si470x_vidioc_s_ctrl,
  1287. .vidioc_g_audio = si470x_vidioc_g_audio,
  1288. .vidioc_g_tuner = si470x_vidioc_g_tuner,
  1289. .vidioc_s_tuner = si470x_vidioc_s_tuner,
  1290. .vidioc_g_frequency = si470x_vidioc_g_frequency,
  1291. .vidioc_s_frequency = si470x_vidioc_s_frequency,
  1292. .vidioc_s_hw_freq_seek = si470x_vidioc_s_hw_freq_seek,
  1293. };
  1294. /*
  1295. * si470x_viddev_template - video device interface
  1296. */
  1297. static struct video_device si470x_viddev_template = {
  1298. .fops = &si470x_fops,
  1299. .name = DRIVER_NAME,
  1300. .release = video_device_release,
  1301. .ioctl_ops = &si470x_ioctl_ops,
  1302. };
  1303. /**************************************************************************
  1304. * USB Interface
  1305. **************************************************************************/
  1306. /*
  1307. * si470x_usb_driver_probe - probe for the device
  1308. */
  1309. static int si470x_usb_driver_probe(struct usb_interface *intf,
  1310. const struct usb_device_id *id)
  1311. {
  1312. struct si470x_device *radio;
  1313. int retval = 0;
  1314. /* private data allocation and initialization */
  1315. radio = kzalloc(sizeof(struct si470x_device), GFP_KERNEL);
  1316. if (!radio) {
  1317. retval = -ENOMEM;
  1318. goto err_initial;
  1319. }
  1320. radio->users = 0;
  1321. radio->disconnected = 0;
  1322. radio->usbdev = interface_to_usbdev(intf);
  1323. radio->intf = intf;
  1324. mutex_init(&radio->disconnect_lock);
  1325. mutex_init(&radio->lock);
  1326. /* video device allocation and initialization */
  1327. radio->videodev = video_device_alloc();
  1328. if (!radio->videodev) {
  1329. retval = -ENOMEM;
  1330. goto err_radio;
  1331. }
  1332. memcpy(radio->videodev, &si470x_viddev_template,
  1333. sizeof(si470x_viddev_template));
  1334. video_set_drvdata(radio->videodev, radio);
  1335. /* show some infos about the specific device */
  1336. if (si470x_get_all_registers(radio) < 0) {
  1337. retval = -EIO;
  1338. goto err_all;
  1339. }
  1340. printk(KERN_INFO DRIVER_NAME ": DeviceID=0x%4.4hx ChipID=0x%4.4hx\n",
  1341. radio->registers[DEVICEID], radio->registers[CHIPID]);
  1342. /* check if firmware is current */
  1343. if ((radio->registers[CHIPID] & CHIPID_FIRMWARE)
  1344. < RADIO_SW_VERSION_CURRENT) {
  1345. printk(KERN_WARNING DRIVER_NAME
  1346. ": This driver is known to work with "
  1347. "firmware version %hu,\n", RADIO_SW_VERSION_CURRENT);
  1348. printk(KERN_WARNING DRIVER_NAME
  1349. ": but the device has firmware version %hu.\n",
  1350. radio->registers[CHIPID] & CHIPID_FIRMWARE);
  1351. printk(KERN_WARNING DRIVER_NAME
  1352. ": If you have some trouble using this driver,\n");
  1353. printk(KERN_WARNING DRIVER_NAME
  1354. ": please report to V4L ML at "
  1355. "video4linux-list@redhat.com\n");
  1356. }
  1357. /* set initial frequency */
  1358. si470x_set_freq(radio, 87.5 * FREQ_MUL); /* available in all regions */
  1359. /* rds buffer allocation */
  1360. radio->buf_size = rds_buf * 3;
  1361. radio->buffer = kmalloc(radio->buf_size, GFP_KERNEL);
  1362. if (!radio->buffer) {
  1363. retval = -EIO;
  1364. goto err_all;
  1365. }
  1366. /* rds buffer configuration */
  1367. radio->wr_index = 0;
  1368. radio->rd_index = 0;
  1369. init_waitqueue_head(&radio->read_queue);
  1370. /* prepare rds work function */
  1371. INIT_DELAYED_WORK(&radio->work, si470x_work);
  1372. /* register video device */
  1373. retval = video_register_device(radio->videodev, VFL_TYPE_RADIO, radio_nr);
  1374. if (retval) {
  1375. printk(KERN_WARNING DRIVER_NAME
  1376. ": Could not register video device\n");
  1377. goto err_all;
  1378. }
  1379. usb_set_intfdata(intf, radio);
  1380. return 0;
  1381. err_all:
  1382. video_device_release(radio->videodev);
  1383. kfree(radio->buffer);
  1384. err_radio:
  1385. kfree(radio);
  1386. err_initial:
  1387. return retval;
  1388. }
  1389. /*
  1390. * si470x_usb_driver_suspend - suspend the device
  1391. */
  1392. static int si470x_usb_driver_suspend(struct usb_interface *intf,
  1393. pm_message_t message)
  1394. {
  1395. struct si470x_device *radio = usb_get_intfdata(intf);
  1396. printk(KERN_INFO DRIVER_NAME ": suspending now...\n");
  1397. cancel_delayed_work_sync(&radio->work);
  1398. return 0;
  1399. }
  1400. /*
  1401. * si470x_usb_driver_resume - resume the device
  1402. */
  1403. static int si470x_usb_driver_resume(struct usb_interface *intf)
  1404. {
  1405. struct si470x_device *radio = usb_get_intfdata(intf);
  1406. printk(KERN_INFO DRIVER_NAME ": resuming now...\n");
  1407. mutex_lock(&radio->lock);
  1408. if (radio->users && radio->registers[SYSCONFIG1] & SYSCONFIG1_RDS)
  1409. schedule_delayed_work(&radio->work,
  1410. msecs_to_jiffies(rds_poll_time));
  1411. mutex_unlock(&radio->lock);
  1412. return 0;
  1413. }
  1414. /*
  1415. * si470x_usb_driver_disconnect - disconnect the device
  1416. */
  1417. static void si470x_usb_driver_disconnect(struct usb_interface *intf)
  1418. {
  1419. struct si470x_device *radio = usb_get_intfdata(intf);
  1420. mutex_lock(&radio->disconnect_lock);
  1421. radio->disconnected = 1;
  1422. cancel_delayed_work_sync(&radio->work);
  1423. usb_set_intfdata(intf, NULL);
  1424. if (radio->users == 0) {
  1425. video_unregister_device(radio->videodev);
  1426. kfree(radio->buffer);
  1427. kfree(radio);
  1428. }
  1429. mutex_unlock(&radio->disconnect_lock);
  1430. }
  1431. /*
  1432. * si470x_usb_driver - usb driver interface
  1433. */
  1434. static struct usb_driver si470x_usb_driver = {
  1435. .name = DRIVER_NAME,
  1436. .probe = si470x_usb_driver_probe,
  1437. .disconnect = si470x_usb_driver_disconnect,
  1438. .suspend = si470x_usb_driver_suspend,
  1439. .resume = si470x_usb_driver_resume,
  1440. .id_table = si470x_usb_driver_id_table,
  1441. .supports_autosuspend = 1,
  1442. };
  1443. /**************************************************************************
  1444. * Module Interface
  1445. **************************************************************************/
  1446. /*
  1447. * si470x_module_init - module init
  1448. */
  1449. static int __init si470x_module_init(void)
  1450. {
  1451. printk(KERN_INFO DRIVER_DESC ", Version " DRIVER_VERSION "\n");
  1452. return usb_register(&si470x_usb_driver);
  1453. }
  1454. /*
  1455. * si470x_module_exit - module exit
  1456. */
  1457. static void __exit si470x_module_exit(void)
  1458. {
  1459. usb_deregister(&si470x_usb_driver);
  1460. }
  1461. module_init(si470x_module_init);
  1462. module_exit(si470x_module_exit);
  1463. MODULE_LICENSE("GPL");
  1464. MODULE_AUTHOR(DRIVER_AUTHOR);
  1465. MODULE_DESCRIPTION(DRIVER_DESC);
  1466. MODULE_VERSION(DRIVER_VERSION);