radio-si470x.c 47 KB

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