em28xx.h 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570
  1. /*
  2. em28xx.h - driver for Empia EM2800/EM2820/2840 USB video capture devices
  3. Copyright (C) 2005 Markus Rechberger <mrechberger@gmail.com>
  4. Ludovico Cavedon <cavedon@sssup.it>
  5. Mauro Carvalho Chehab <mchehab@infradead.org>
  6. Based on the em2800 driver from Sascha Sommer <saschasommer@freenet.de>
  7. This program is free software; you can redistribute it and/or modify
  8. it under the terms of the GNU General Public License as published by
  9. the Free Software Foundation; either version 2 of the License, or
  10. (at your option) any later version.
  11. This program is distributed in the hope that it will be useful,
  12. but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. GNU General Public License for more details.
  15. You should have received a copy of the GNU General Public License
  16. along with this program; if not, write to the Free Software
  17. Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18. */
  19. #ifndef _EM28XX_H
  20. #define _EM28XX_H
  21. #include <linux/videodev2.h>
  22. #include <linux/i2c.h>
  23. #include <linux/mutex.h>
  24. #include <media/ir-kbd-i2c.h>
  25. /* Boards supported by driver */
  26. #define EM2800_BOARD_UNKNOWN 0
  27. #define EM2820_BOARD_UNKNOWN 1
  28. #define EM2820_BOARD_TERRATEC_CINERGY_250 2
  29. #define EM2820_BOARD_PINNACLE_USB_2 3
  30. #define EM2820_BOARD_HAUPPAUGE_WINTV_USB_2 4
  31. #define EM2820_BOARD_MSI_VOX_USB_2 5
  32. #define EM2800_BOARD_TERRATEC_CINERGY_200 6
  33. #define EM2800_BOARD_LEADTEK_WINFAST_USBII 7
  34. #define EM2800_BOARD_KWORLD_USB2800 8
  35. #define EM2820_BOARD_PINNACLE_DVC_90 9
  36. #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_900 10
  37. #define EM2880_BOARD_TERRATEC_HYBRID_XS 11
  38. #define EM2820_BOARD_KWORLD_PVRTV2800RF 12
  39. #define EM2880_BOARD_TERRATEC_PRODIGY_XS 13
  40. #define EM2820_BOARD_PROLINK_PLAYTV_USB2 14
  41. #define EM2800_BOARD_VGEAR_POCKETTV 15
  42. #define EM2880_BOARD_HAUPPAUGE_WINTV_HVR_950 16
  43. #define UNSET -1
  44. /* maximum number of em28xx boards */
  45. #define EM28XX_MAXBOARDS 1 /*FIXME: should be bigger */
  46. /* maximum number of frames that can be queued */
  47. #define EM28XX_NUM_FRAMES 5
  48. /* number of frames that get used for v4l2_read() */
  49. #define EM28XX_NUM_READ_FRAMES 2
  50. /* number of buffers for isoc transfers */
  51. #define EM28XX_NUM_BUFS 5
  52. /* number of packets for each buffer
  53. windows requests only 40 packets .. so we better do the same
  54. this is what I found out for all alternate numbers there!
  55. */
  56. #define EM28XX_NUM_PACKETS 40
  57. /* default alternate; 0 means choose the best */
  58. #define EM28XX_PINOUT 0
  59. #define EM28XX_INTERLACED_DEFAULT 1
  60. /*
  61. #define (use usbview if you want to get the other alternate number infos)
  62. #define
  63. #define alternate number 2
  64. #define Endpoint Address: 82
  65. Direction: in
  66. Attribute: 1
  67. Type: Isoc
  68. Max Packet Size: 1448
  69. Interval: 125us
  70. alternate number 7
  71. Endpoint Address: 82
  72. Direction: in
  73. Attribute: 1
  74. Type: Isoc
  75. Max Packet Size: 3072
  76. Interval: 125us
  77. */
  78. /* time to wait when stopping the isoc transfer */
  79. #define EM28XX_URB_TIMEOUT msecs_to_jiffies(EM28XX_NUM_BUFS * EM28XX_NUM_PACKETS)
  80. /* time in msecs to wait for i2c writes to finish */
  81. #define EM2800_I2C_WRITE_TIMEOUT 20
  82. /* the various frame states */
  83. enum em28xx_frame_state {
  84. F_UNUSED = 0,
  85. F_QUEUED,
  86. F_GRABBING,
  87. F_DONE,
  88. F_ERROR,
  89. };
  90. /* stream states */
  91. enum em28xx_stream_state {
  92. STREAM_OFF,
  93. STREAM_INTERRUPT,
  94. STREAM_ON,
  95. };
  96. /* frames */
  97. struct em28xx_frame_t {
  98. void *bufmem;
  99. struct v4l2_buffer buf;
  100. enum em28xx_frame_state state;
  101. struct list_head frame;
  102. unsigned long vma_use_count;
  103. int top_field;
  104. int fieldbytesused;
  105. };
  106. /* io methods */
  107. enum em28xx_io_method {
  108. IO_NONE,
  109. IO_READ,
  110. IO_MMAP,
  111. };
  112. /* inputs */
  113. #define MAX_EM28XX_INPUT 4
  114. enum enum28xx_itype {
  115. EM28XX_VMUX_COMPOSITE1 = 1,
  116. EM28XX_VMUX_COMPOSITE2,
  117. EM28XX_VMUX_COMPOSITE3,
  118. EM28XX_VMUX_COMPOSITE4,
  119. EM28XX_VMUX_SVIDEO,
  120. EM28XX_VMUX_TELEVISION,
  121. EM28XX_VMUX_CABLE,
  122. EM28XX_VMUX_DVB,
  123. EM28XX_VMUX_DEBUG,
  124. EM28XX_RADIO,
  125. };
  126. enum em28xx_amux {
  127. EM28XX_AMUX_VIDEO,
  128. EM28XX_AMUX_LINE_IN,
  129. EM28XX_AMUX_AC97_VIDEO,
  130. EM28XX_AMUX_AC97_LINE_IN,
  131. };
  132. struct em28xx_input {
  133. enum enum28xx_itype type;
  134. unsigned int vmux;
  135. enum em28xx_amux amux;
  136. };
  137. #define INPUT(nr) (&em28xx_boards[dev->model].input[nr])
  138. enum em28xx_decoder {
  139. EM28XX_TVP5150,
  140. EM28XX_SAA7113,
  141. EM28XX_SAA7114
  142. };
  143. struct em28xx_board {
  144. char *name;
  145. int vchannels;
  146. int tuner_type;
  147. /* i2c flags */
  148. unsigned int tda9887_conf;
  149. unsigned int is_em2800:1;
  150. unsigned int has_tuner:1;
  151. unsigned int has_msp34xx:1;
  152. unsigned int mts_firmware:1;
  153. unsigned int has_12mhz_i2s:1;
  154. unsigned int analog_gpio;
  155. enum em28xx_decoder decoder;
  156. struct em28xx_input input[MAX_EM28XX_INPUT];
  157. struct em28xx_input radio;
  158. };
  159. struct em28xx_eeprom {
  160. u32 id; /* 0x9567eb1a */
  161. u16 vendor_ID;
  162. u16 product_ID;
  163. u16 chip_conf;
  164. u16 board_conf;
  165. u16 string1, string2, string3;
  166. u8 string_idx_table;
  167. };
  168. /* device states */
  169. enum em28xx_dev_state {
  170. DEV_INITIALIZED = 0x01,
  171. DEV_DISCONNECTED = 0x02,
  172. DEV_MISCONFIGURED = 0x04,
  173. };
  174. #define EM28XX_AUDIO_BUFS 5
  175. #define EM28XX_NUM_AUDIO_PACKETS 64
  176. #define EM28XX_AUDIO_MAX_PACKET_SIZE 196 /* static value */
  177. #define EM28XX_CAPTURE_STREAM_EN 1
  178. #define EM28XX_AUDIO 0x10
  179. struct em28xx_audio {
  180. char name[50];
  181. char *transfer_buffer[EM28XX_AUDIO_BUFS];
  182. struct urb *urb[EM28XX_AUDIO_BUFS];
  183. struct usb_device *udev;
  184. unsigned int capture_transfer_done;
  185. struct snd_pcm_substream *capture_pcm_substream;
  186. unsigned int hwptr_done_capture;
  187. struct snd_card *sndcard;
  188. int users, shutdown;
  189. enum em28xx_stream_state capture_stream;
  190. spinlock_t slock;
  191. };
  192. /* main device struct */
  193. struct em28xx {
  194. /* generic device properties */
  195. char name[30]; /* name (including minor) of the device */
  196. int model; /* index in the device_data struct */
  197. int devno; /* marks the number of this device */
  198. unsigned int analog_gpio;
  199. unsigned int is_em2800:1;
  200. unsigned int has_tuner:1;
  201. unsigned int has_msp34xx:1;
  202. unsigned int has_tda9887:1;
  203. unsigned int stream_on:1; /* Locks streams */
  204. unsigned int has_audio_class:1;
  205. unsigned int has_12mhz_i2s:1;
  206. int video_inputs; /* number of video inputs */
  207. struct list_head devlist;
  208. u32 i2s_speed; /* I2S speed for audio digital stream */
  209. enum em28xx_decoder decoder;
  210. int tuner_type; /* type of the tuner */
  211. int tuner_addr; /* tuner address */
  212. int tda9887_conf;
  213. /* i2c i/o */
  214. struct i2c_adapter i2c_adap;
  215. struct i2c_client i2c_client;
  216. /* video for linux */
  217. int users; /* user count for exclusive use */
  218. struct video_device *vdev; /* video for linux device struct */
  219. v4l2_std_id norm; /* selected tv norm */
  220. int ctl_freq; /* selected frequency */
  221. unsigned int ctl_input; /* selected input */
  222. unsigned int ctl_ainput; /* slected audio input */
  223. int mute;
  224. int volume;
  225. /* frame properties */
  226. struct em28xx_frame_t frame[EM28XX_NUM_FRAMES]; /* list of frames */
  227. int num_frames; /* number of frames currently in use */
  228. unsigned int frame_count; /* total number of transfered frames */
  229. struct em28xx_frame_t *frame_current; /* the frame that is being filled */
  230. int width; /* current frame width */
  231. int height; /* current frame height */
  232. int frame_size; /* current frame size */
  233. int field_size; /* current field size */
  234. int bytesperline;
  235. int hscale; /* horizontal scale factor (see datasheet) */
  236. int vscale; /* vertical scale factor (see datasheet) */
  237. int interlaced; /* 1=interlace fileds, 0=just top fileds */
  238. int type;
  239. unsigned int video_bytesread; /* Number of bytes read */
  240. unsigned long hash; /* eeprom hash - for boards with generic ID */
  241. unsigned long i2c_hash; /* i2c devicelist hash - for boards with generic ID */
  242. struct em28xx_audio *adev;
  243. /* states */
  244. enum em28xx_dev_state state;
  245. enum em28xx_stream_state stream;
  246. enum em28xx_io_method io;
  247. struct work_struct request_module_wk;
  248. /* locks */
  249. struct mutex lock;
  250. spinlock_t queue_lock;
  251. struct list_head inqueue, outqueue;
  252. wait_queue_head_t open, wait_frame, wait_stream;
  253. struct video_device *vbi_dev;
  254. struct video_device *radio_dev;
  255. unsigned char eedata[256];
  256. /* usb transfer */
  257. struct usb_device *udev; /* the usb device */
  258. int alt; /* alternate */
  259. int max_pkt_size; /* max packet size of isoc transaction */
  260. int num_alt; /* Number of alternative settings */
  261. unsigned int *alt_max_pkt_size; /* array of wMaxPacketSize */
  262. struct urb *urb[EM28XX_NUM_BUFS]; /* urb for isoc transfers */
  263. char *transfer_buffer[EM28XX_NUM_BUFS]; /* transfer buffers for isoc transfer */
  264. /* helper funcs that call usb_control_msg */
  265. int (*em28xx_write_regs) (struct em28xx * dev, u16 reg, char *buf,
  266. int len);
  267. int (*em28xx_read_reg) (struct em28xx * dev, u16 reg);
  268. int (*em28xx_read_reg_req_len) (struct em28xx * dev, u8 req, u16 reg,
  269. char *buf, int len);
  270. int (*em28xx_write_regs_req) (struct em28xx * dev, u8 req, u16 reg,
  271. char *buf, int len);
  272. int (*em28xx_read_reg_req) (struct em28xx * dev, u8 req, u16 reg);
  273. };
  274. struct em28xx_fh {
  275. struct em28xx *dev;
  276. unsigned int stream_on:1; /* Locks streams */
  277. int radio;
  278. };
  279. struct em28xx_ops {
  280. struct list_head next;
  281. char *name;
  282. int id;
  283. int (*init)(struct em28xx *);
  284. int (*fini)(struct em28xx *);
  285. };
  286. /* Provided by em28xx-i2c.c */
  287. void em28xx_i2c_call_clients(struct em28xx *dev, unsigned int cmd, void *arg);
  288. void em28xx_do_i2c_scan(struct em28xx *dev);
  289. int em28xx_i2c_register(struct em28xx *dev);
  290. int em28xx_i2c_unregister(struct em28xx *dev);
  291. /* Provided by em28xx-input.c */
  292. void em28xx_set_ir(struct em28xx * dev,struct IR_i2c *ir);
  293. /* Provided by em28xx-core.c */
  294. u32 em28xx_request_buffers(struct em28xx *dev, u32 count);
  295. void em28xx_queue_unusedframes(struct em28xx *dev);
  296. void em28xx_release_buffers(struct em28xx *dev);
  297. int em28xx_read_reg_req_len(struct em28xx *dev, u8 req, u16 reg,
  298. char *buf, int len);
  299. int em28xx_read_reg_req(struct em28xx *dev, u8 req, u16 reg);
  300. int em28xx_read_reg(struct em28xx *dev, u16 reg);
  301. int em28xx_write_regs_req(struct em28xx *dev, u8 req, u16 reg, char *buf,
  302. int len);
  303. int em28xx_write_regs(struct em28xx *dev, u16 reg, char *buf, int len);
  304. int em28xx_write_reg_bits(struct em28xx *dev, u16 reg, u8 val,
  305. u8 bitmask);
  306. int em28xx_set_audio_source(struct em28xx *dev);
  307. int em28xx_audio_analog_set(struct em28xx *dev);
  308. int em28xx_colorlevels_set_default(struct em28xx *dev);
  309. int em28xx_capture_start(struct em28xx *dev, int start);
  310. int em28xx_outfmt_set_yuv422(struct em28xx *dev);
  311. int em28xx_resolution_set(struct em28xx *dev);
  312. int em28xx_init_isoc(struct em28xx *dev);
  313. void em28xx_uninit_isoc(struct em28xx *dev);
  314. int em28xx_set_alternate(struct em28xx *dev);
  315. /* Provided by em28xx-video.c */
  316. int em28xx_register_extension(struct em28xx_ops *dev);
  317. void em28xx_unregister_extension(struct em28xx_ops *dev);
  318. /* Provided by em28xx-cards.c */
  319. extern int em2800_variant_detect(struct usb_device* udev,int model);
  320. extern void em28xx_pre_card_setup(struct em28xx *dev);
  321. extern void em28xx_card_setup(struct em28xx *dev);
  322. extern struct em28xx_board em28xx_boards[];
  323. extern struct usb_device_id em28xx_id_table[];
  324. extern const unsigned int em28xx_bcount;
  325. /* em2800 registers */
  326. #define EM2800_AUDIOSRC_REG 0x08
  327. /* em28xx registers */
  328. #define I2C_CLK_REG 0x06
  329. #define CHIPID_REG 0x0a
  330. #define USBSUSP_REG 0x0c /* */
  331. #define AUDIOSRC_REG 0x0e
  332. #define XCLK_REG 0x0f
  333. #define VINMODE_REG 0x10
  334. #define VINCTRL_REG 0x11
  335. #define VINENABLE_REG 0x12 /* */
  336. #define GAMMA_REG 0x14
  337. #define RGAIN_REG 0x15
  338. #define GGAIN_REG 0x16
  339. #define BGAIN_REG 0x17
  340. #define ROFFSET_REG 0x18
  341. #define GOFFSET_REG 0x19
  342. #define BOFFSET_REG 0x1a
  343. #define OFLOW_REG 0x1b
  344. #define HSTART_REG 0x1c
  345. #define VSTART_REG 0x1d
  346. #define CWIDTH_REG 0x1e
  347. #define CHEIGHT_REG 0x1f
  348. #define YGAIN_REG 0x20
  349. #define YOFFSET_REG 0x21
  350. #define UVGAIN_REG 0x22
  351. #define UOFFSET_REG 0x23
  352. #define VOFFSET_REG 0x24
  353. #define SHARPNESS_REG 0x25
  354. #define COMPR_REG 0x26
  355. #define OUTFMT_REG 0x27
  356. #define XMIN_REG 0x28
  357. #define XMAX_REG 0x29
  358. #define YMIN_REG 0x2a
  359. #define YMAX_REG 0x2b
  360. #define HSCALELOW_REG 0x30
  361. #define HSCALEHIGH_REG 0x31
  362. #define VSCALELOW_REG 0x32
  363. #define VSCALEHIGH_REG 0x33
  364. #define AC97LSB_REG 0x40
  365. #define AC97MSB_REG 0x41
  366. #define AC97ADDR_REG 0x42
  367. #define AC97BUSY_REG 0x43
  368. /* em202 registers */
  369. #define MASTER_AC97 0x02
  370. #define LINE_IN_AC97 0x10
  371. #define VIDEO_AC97 0x14
  372. /* register settings */
  373. #define EM2800_AUDIO_SRC_TUNER 0x0d
  374. #define EM2800_AUDIO_SRC_LINE 0x0c
  375. #define EM28XX_AUDIO_SRC_TUNER 0xc0
  376. #define EM28XX_AUDIO_SRC_LINE 0x80
  377. /* printk macros */
  378. #define em28xx_err(fmt, arg...) do {\
  379. printk(KERN_ERR fmt , ##arg); } while (0)
  380. #define em28xx_errdev(fmt, arg...) do {\
  381. printk(KERN_ERR "%s: "fmt,\
  382. dev->name , ##arg); } while (0)
  383. #define em28xx_info(fmt, arg...) do {\
  384. printk(KERN_INFO "%s: "fmt,\
  385. dev->name , ##arg); } while (0)
  386. #define em28xx_warn(fmt, arg...) do {\
  387. printk(KERN_WARNING "%s: "fmt,\
  388. dev->name , ##arg); } while (0)
  389. inline static int em28xx_compression_disable(struct em28xx *dev)
  390. {
  391. /* side effect of disabling scaler and mixer */
  392. return em28xx_write_regs(dev, COMPR_REG, "\x00", 1);
  393. }
  394. inline static int em28xx_contrast_get(struct em28xx *dev)
  395. {
  396. return em28xx_read_reg(dev, YGAIN_REG) & 0x1f;
  397. }
  398. inline static int em28xx_brightness_get(struct em28xx *dev)
  399. {
  400. return em28xx_read_reg(dev, YOFFSET_REG);
  401. }
  402. inline static int em28xx_saturation_get(struct em28xx *dev)
  403. {
  404. return em28xx_read_reg(dev, UVGAIN_REG) & 0x1f;
  405. }
  406. inline static int em28xx_u_balance_get(struct em28xx *dev)
  407. {
  408. return em28xx_read_reg(dev, UOFFSET_REG);
  409. }
  410. inline static int em28xx_v_balance_get(struct em28xx *dev)
  411. {
  412. return em28xx_read_reg(dev, VOFFSET_REG);
  413. }
  414. inline static int em28xx_gamma_get(struct em28xx *dev)
  415. {
  416. return em28xx_read_reg(dev, GAMMA_REG) & 0x3f;
  417. }
  418. inline static int em28xx_contrast_set(struct em28xx *dev, s32 val)
  419. {
  420. u8 tmp = (u8) val;
  421. return em28xx_write_regs(dev, YGAIN_REG, &tmp, 1);
  422. }
  423. inline static int em28xx_brightness_set(struct em28xx *dev, s32 val)
  424. {
  425. u8 tmp = (u8) val;
  426. return em28xx_write_regs(dev, YOFFSET_REG, &tmp, 1);
  427. }
  428. inline static int em28xx_saturation_set(struct em28xx *dev, s32 val)
  429. {
  430. u8 tmp = (u8) val;
  431. return em28xx_write_regs(dev, UVGAIN_REG, &tmp, 1);
  432. }
  433. inline static int em28xx_u_balance_set(struct em28xx *dev, s32 val)
  434. {
  435. u8 tmp = (u8) val;
  436. return em28xx_write_regs(dev, UOFFSET_REG, &tmp, 1);
  437. }
  438. inline static int em28xx_v_balance_set(struct em28xx *dev, s32 val)
  439. {
  440. u8 tmp = (u8) val;
  441. return em28xx_write_regs(dev, VOFFSET_REG, &tmp, 1);
  442. }
  443. inline static int em28xx_gamma_set(struct em28xx *dev, s32 val)
  444. {
  445. u8 tmp = (u8) val;
  446. return em28xx_write_regs(dev, GAMMA_REG, &tmp, 1);
  447. }
  448. /*FIXME: maxw should be dependent of alt mode */
  449. inline static unsigned int norm_maxw(struct em28xx *dev)
  450. {
  451. switch (dev->model) {
  452. case EM2820_BOARD_MSI_VOX_USB_2:
  453. return 640;
  454. default:
  455. return 720;
  456. }
  457. }
  458. inline static unsigned int norm_maxh(struct em28xx *dev)
  459. {
  460. switch (dev->model) {
  461. case EM2820_BOARD_MSI_VOX_USB_2:
  462. return 480;
  463. default:
  464. return (dev->norm & V4L2_STD_625_50) ? 576 : 480;
  465. }
  466. }
  467. #endif