saa7164.h

  1/* SPDX-License-Identifier: GPL-2.0-or-later */
  2/*
  3 *  Driver for the NXP SAA7164 PCIe bridge
  4 *
  5 *  Copyright (c) 2010-2015 Steven Toth <stoth@kernellabs.com>
  6 */
  7
  8/*
  9	Driver architecture
 10	*******************
 11
 12	saa7164_core.c/buffer.c/cards.c/i2c.c/dvb.c
 13		|	: Standard Linux driver framework for creating
 14		|	: exposing and managing interfaces to the rest
 15		|	: of the kernel or userland. Also uses _fw.c to load
 16		|	: firmware direct into the PCIe bus, bypassing layers.
 17		V
 18	saa7164_api..()	: Translate kernel specific functions/features
 19		|	: into command buffers.
 20		V
 21	saa7164_cmd..()	: Manages the flow of command packets on/off,
 22		|	: the bus. Deal with bus errors, timeouts etc.
 23		V
 24	saa7164_bus..() : Manage a read/write memory ring buffer in the
 25		|	: PCIe Address space.
 26		|
 27		|		saa7164_fw...()	: Load any firmware
 28		|			|	: direct into the device
 29		V			V
 30	<- ----------------- PCIe address space -------------------- ->
 31*/
 32
 33#include <linux/pci.h>
 34#include <linux/i2c.h>
 35#include <linux/kdev_t.h>
 36#include <linux/mutex.h>
 37#include <linux/crc32.h>
 38#include <linux/kthread.h>
 39#include <linux/freezer.h>
 40
 41#include <media/tuner.h>
 42#include <media/tveeprom.h>
 43#include <media/dvb_demux.h>
 44#include <media/dvb_frontend.h>
 45#include <media/dvb_net.h>
 46#include <media/dvbdev.h>
 47#include <media/dmxdev.h>
 48#include <media/v4l2-common.h>
 49#include <media/v4l2-ioctl.h>
 50#include <media/v4l2-device.h>
 51#include <media/v4l2-ctrls.h>
 52#include <media/v4l2-event.h>
 53
 54#include "saa7164-reg.h"
 55#include "saa7164-types.h"
 56
 57#define SAA7164_MAXBOARDS 8
 58
 59#define UNSET (-1U)
 60#define SAA7164_BOARD_NOAUTO			UNSET
 61#define SAA7164_BOARD_UNKNOWN			0
 62#define SAA7164_BOARD_UNKNOWN_REV2		1
 63#define SAA7164_BOARD_UNKNOWN_REV3		2
 64#define SAA7164_BOARD_HAUPPAUGE_HVR2250		3
 65#define SAA7164_BOARD_HAUPPAUGE_HVR2200		4
 66#define SAA7164_BOARD_HAUPPAUGE_HVR2200_2	5
 67#define SAA7164_BOARD_HAUPPAUGE_HVR2200_3	6
 68#define SAA7164_BOARD_HAUPPAUGE_HVR2250_2	7
 69#define SAA7164_BOARD_HAUPPAUGE_HVR2250_3	8
 70#define SAA7164_BOARD_HAUPPAUGE_HVR2200_4	9
 71#define SAA7164_BOARD_HAUPPAUGE_HVR2200_5	10
 72#define SAA7164_BOARD_HAUPPAUGE_HVR2255proto	11
 73#define SAA7164_BOARD_HAUPPAUGE_HVR2255		12
 74#define SAA7164_BOARD_HAUPPAUGE_HVR2205		13
 75
 76#define SAA7164_MAX_UNITS		8
 77#define SAA7164_TS_NUMBER_OF_LINES	312
 78#define SAA7164_PS_NUMBER_OF_LINES	256
 79#define SAA7164_PT_ENTRIES		16 /* (312 * 188) / 4096 */
 80#define SAA7164_MAX_ENCODER_BUFFERS	64 /* max 5secs of latency at 6Mbps */
 81#define SAA7164_MAX_VBI_BUFFERS		64
 82
 83/* Port related defines */
 84#define SAA7164_PORT_TS1	(0)
 85#define SAA7164_PORT_TS2	(SAA7164_PORT_TS1 + 1)
 86#define SAA7164_PORT_ENC1	(SAA7164_PORT_TS2 + 1)
 87#define SAA7164_PORT_ENC2	(SAA7164_PORT_ENC1 + 1)
 88#define SAA7164_PORT_VBI1	(SAA7164_PORT_ENC2 + 1)
 89#define SAA7164_PORT_VBI2	(SAA7164_PORT_VBI1 + 1)
 90#define SAA7164_MAX_PORTS	(SAA7164_PORT_VBI2 + 1)
 91
 92#define DBGLVL_FW    4
 93#define DBGLVL_DVB   8
 94#define DBGLVL_I2C  16
 95#define DBGLVL_API  32
 96#define DBGLVL_CMD  64
 97#define DBGLVL_BUS 128
 98#define DBGLVL_IRQ 256
 99#define DBGLVL_BUF 512
100#define DBGLVL_ENC 1024
101#define DBGLVL_VBI 2048
102#define DBGLVL_THR 4096
103#define DBGLVL_CPU 8192
104
105#define SAA7164_NORMS \
106	(V4L2_STD_NTSC_M | V4L2_STD_NTSC_M_JP)
107
108/* TV frequency range copied from tuner-core.c */
109#define SAA7164_TV_MIN_FREQ (44U * 16U)
110#define SAA7164_TV_MAX_FREQ (958U * 16U)
111
112enum port_t {
113	SAA7164_MPEG_UNDEFINED = 0,
114	SAA7164_MPEG_DVB,
115	SAA7164_MPEG_ENCODER,
116	SAA7164_MPEG_VBI,
117};
118
119enum saa7164_i2c_bus_nr {
120	SAA7164_I2C_BUS_0 = 0,
121	SAA7164_I2C_BUS_1,
122	SAA7164_I2C_BUS_2,
123};
124
125enum saa7164_buffer_flags {
126	SAA7164_BUFFER_UNDEFINED = 0,
127	SAA7164_BUFFER_FREE,
128	SAA7164_BUFFER_BUSY,
129	SAA7164_BUFFER_FULL
130};
131
132enum saa7164_unit_type {
133	SAA7164_UNIT_UNDEFINED = 0,
134	SAA7164_UNIT_DIGITAL_DEMODULATOR,
135	SAA7164_UNIT_ANALOG_DEMODULATOR,
136	SAA7164_UNIT_TUNER,
137	SAA7164_UNIT_EEPROM,
138	SAA7164_UNIT_ZILOG_IRBLASTER,
139	SAA7164_UNIT_ENCODER,
140};
141
142/* The PCIe bridge doesn't grant direct access to i2c.
143 * Instead, you address i2c devices using a uniqely
144 * allocated 'unitid' value via a messaging API. This
145 * is a problem. The kernel and existing demod/tuner
146 * drivers expect to talk 'i2c', so we have to maintain
147 * a translation layer, and a series of functions to
148 * convert i2c bus + device address into a unit id.
149 */
150struct saa7164_unit {
151	enum saa7164_unit_type type;
152	u8	id;
153	char	*name;
154	enum saa7164_i2c_bus_nr i2c_bus_nr;
155	u8	i2c_bus_addr;
156	u8	i2c_reg_len;
157};
158
159struct saa7164_board {
160	char	*name;
161	enum port_t porta, portb, portc,
162		portd, porte, portf;
163	enum {
164		SAA7164_CHIP_UNDEFINED = 0,
165		SAA7164_CHIP_REV2,
166		SAA7164_CHIP_REV3,
167	} chiprev;
168	struct	saa7164_unit unit[SAA7164_MAX_UNITS];
169};
170
171struct saa7164_subid {
172	u16     subvendor;
173	u16     subdevice;
174	u32     card;
175};
176
177struct saa7164_encoder_fh {
178	struct v4l2_fh fh;
179	struct saa7164_port *port;
180	atomic_t v4l_reading;
181};
182
183static inline struct saa7164_encoder_fh *to_saa7164_encoder_fh(struct file *filp)
184{
185	return container_of(file_to_v4l2_fh(filp), struct saa7164_encoder_fh, fh);
186}
187
188struct saa7164_vbi_fh {
189	struct v4l2_fh fh;
190	struct saa7164_port *port;
191	atomic_t v4l_reading;
192};
193
194static inline struct saa7164_vbi_fh *to_saa7164_vbi_fh(struct file *filp)
195{
196	return container_of(file_to_v4l2_fh(filp), struct saa7164_vbi_fh, fh);
197}
198
199struct saa7164_histogram_bucket {
200	u32 val;
201	u32 count;
202	u64 update_time;
203};
204
205struct saa7164_histogram {
206	char name[32];
207	struct saa7164_histogram_bucket counter1[64];
208};
209
210struct saa7164_user_buffer {
211	struct list_head list;
212
213	/* Attributes */
214	u8  *data;
215	u32 pos;
216	u32 actual_size;
217
218	u32 crc;
219};
220
221struct saa7164_fw_status {
222
223	/* RISC Core details */
224	u32	status;
225	u32	mode;
226	u32	spec;
227	u32	inst;
228	u32	cpuload;
229	u32	remainheap;
230
231	/* Firmware version */
232	u32	version;
233	u32	major;
234	u32	sub;
235	u32	rel;
236	u32	buildnr;
237};
238
239struct saa7164_dvb {
240	struct mutex lock;
241	struct dvb_adapter adapter;
242	struct dvb_frontend *frontend;
243	struct dvb_demux demux;
244	struct dmxdev dmxdev;
245	struct dmx_frontend fe_hw;
246	struct dmx_frontend fe_mem;
247	struct dvb_net net;
248	int feeding;
249};
250
251struct saa7164_i2c {
252	struct saa7164_dev		*dev;
253
254	enum saa7164_i2c_bus_nr		nr;
255
256	/* I2C I/O */
257	struct i2c_adapter		i2c_adap;
258	struct i2c_client		i2c_client;
259	u32				i2c_rc;
260};
261
262struct saa7164_tvnorm {
263	char		*name;
264	v4l2_std_id	id;
265};
266
267struct saa7164_encoder_params {
268	struct saa7164_tvnorm encodernorm;
269	u32 height;
270	u32 width;
271	u32 is_50hz;
272	u32 bitrate; /* bps */
273	u32 bitrate_peak; /* bps */
274	u32 bitrate_mode;
275	u32 stream_type; /* V4L2_MPEG_STREAM_TYPE_MPEG2_TS */
276
277	u32 audio_sampling_freq;
278	u32 ctl_mute;
279	u32 ctl_aspect;
280	u32 refdist;
281	u32 gop_size;
282};
283
284struct saa7164_vbi_params {
285	struct saa7164_tvnorm encodernorm;
286	u32 height;
287	u32 width;
288	u32 is_50hz;
289	u32 bitrate; /* bps */
290	u32 bitrate_peak; /* bps */
291	u32 bitrate_mode;
292	u32 stream_type; /* V4L2_MPEG_STREAM_TYPE_MPEG2_TS */
293
294	u32 audio_sampling_freq;
295	u32 ctl_mute;
296	u32 ctl_aspect;
297	u32 refdist;
298	u32 gop_size;
299};
300
301struct saa7164_port;
302
303struct saa7164_buffer {
304	struct list_head list;
305
306	/* Note of which h/w buffer list index position we occupy */
307	int idx;
308
309	struct saa7164_port *port;
310
311	/* Hardware Specific */
312	/* PCI Memory allocations */
313	enum saa7164_buffer_flags flags; /* Free, Busy, Full */
314
315	/* A block of page align PCI memory */
316	u32 pci_size;	/* PCI allocation size in bytes */
317	u64 *cpu;	/* Virtual address */
318	dma_addr_t dma;	/* Physical address */
319	u32 crc;	/* Checksum for the entire buffer data */
320
321	/* A page table that splits the block into a number of entries */
322	u32 pt_size;		/* PCI allocation size in bytes */
323	u64 *pt_cpu;		/* Virtual address */
324	dma_addr_t pt_dma;	/* Physical address */
325
326	/* Encoder fops */
327	u32 pos;
328	u32 actual_size;
329};
330
331struct saa7164_port {
332
333	struct saa7164_dev *dev;
334	enum port_t type;
335	int nr;
336
337	/* --- Generic port attributes --- */
338
339	/* HW stream parameters */
340	struct tmHWStreamParameters hw_streamingparams;
341
342	/* DMA configuration values, is seeded during initialization */
343	struct tmComResDMATermDescrHeader hwcfg;
344
345	/* hardware specific registers */
346	u32 bufcounter;
347	u32 pitch;
348	u32 bufsize;
349	u32 bufoffset;
350	u32 bufptr32l;
351	u32 bufptr32h;
352	u64 bufptr64;
353
354	u32 numpte;	/* Number of entries in array, only valid in head */
355
356	struct mutex dmaqueue_lock;
357	struct saa7164_buffer dmaqueue;
358
359	u64 last_irq_msecs, last_svc_msecs;
360	u64 last_irq_msecs_diff, last_svc_msecs_diff;
361	u32 last_svc_wp;
362	u32 last_svc_rp;
363	u64 last_irq_svc_msecs_diff;
364	u64 last_read_msecs, last_read_msecs_diff;
365	u64 last_poll_msecs, last_poll_msecs_diff;
366
367	struct saa7164_histogram irq_interval;
368	struct saa7164_histogram svc_interval;
369	struct saa7164_histogram irq_svc_interval;
370	struct saa7164_histogram read_interval;
371	struct saa7164_histogram poll_interval;
372
373	/* --- DVB Transport Specific --- */
374	struct saa7164_dvb dvb;
375	struct i2c_client *i2c_client_demod;
376	struct i2c_client *i2c_client_tuner;
377
378	/* --- Encoder/V4L related attributes --- */
379	/* Encoder */
380	/* Defaults established in saa7164-encoder.c */
381	struct saa7164_tvnorm encodernorm;
382	struct v4l2_ctrl_handler ctrl_handler;
383	v4l2_std_id std;
384	u32 height;
385	u32 width;
386	u32 freq;
387	u8 mux_input;
388	u8 encoder_profile;
389	u8 video_format;
390	u8 audio_format;
391	u8 video_resolution;
392	u16 ctl_brightness;
393	u16 ctl_contrast;
394	u16 ctl_hue;
395	u16 ctl_saturation;
396	u16 ctl_sharpness;
397	s8 ctl_volume;
398
399	struct tmComResAFeatureDescrHeader audfeat;
400	struct tmComResEncoderDescrHeader encunit;
401	struct tmComResProcDescrHeader vidproc;
402	struct tmComResExtDevDescrHeader ifunit;
403	struct tmComResTunerDescrHeader tunerunit;
404
405	struct work_struct workenc;
406
407	/* V4L Encoder Video */
408	struct saa7164_encoder_params encoder_params;
409	struct video_device *v4l_device;
410	atomic_t v4l_reader_count;
411
412	struct saa7164_buffer list_buf_used;
413	struct saa7164_buffer list_buf_free;
414	wait_queue_head_t wait_read;
415
416	/* V4L VBI */
417	struct tmComResVBIFormatDescrHeader vbi_fmt_ntsc;
418	struct saa7164_vbi_params vbi_params;
419	struct saa7164_port *enc_port;
420
421	/* Debug */
422	u32 sync_errors;
423	u32 v_cc_errors;
424	u32 a_cc_errors;
425	u8 last_v_cc;
426	u8 last_a_cc;
427	u32 done_first_interrupt;
428};
429
430struct saa7164_dev {
431	struct list_head	devlist;
432	atomic_t		refcount;
433
434	struct v4l2_device v4l2_dev;
435
436	/* pci stuff */
437	struct pci_dev	*pci;
438	unsigned char	pci_rev, pci_lat;
439	int		pci_bus, pci_slot;
440	u32		__iomem *lmmio;
441	u8		__iomem *bmmio;
442	u32		__iomem *lmmio2;
443	u8		__iomem *bmmio2;
444	int		pci_irqmask;
445
446	/* board details */
447	int	nr;
448	int	hwrevision;
449	u32	board;
450	char	name[16];
451
452	/* firmware status */
453	struct saa7164_fw_status	fw_status;
454	u32				firmwareloaded;
455
456	struct tmComResHWDescr		hwdesc;
457	struct tmComResInterfaceDescr	intfdesc;
458	struct tmComResBusDescr		busdesc;
459
460	struct tmComResBusInfo		bus;
461
462	/* Interrupt status and ack registers */
463	u32 int_status;
464	u32 int_ack;
465	bool msi;
466
467	struct cmd			cmds[SAA_CMD_MAX_MSG_UNITS];
468	struct mutex			lock;
469
470	/* I2c related */
471	struct saa7164_i2c i2c_bus[3];
472
473	/* Transport related */
474	struct saa7164_port ports[SAA7164_MAX_PORTS];
475
476	/* Deferred command/api interrupts handling */
477	struct work_struct workcmd;
478
479	/* A kernel thread to monitor the firmware log, used
480	 * only in debug mode.
481	 */
482	struct task_struct *kthread;
483
484};
485
486extern struct list_head saa7164_devlist;
487extern unsigned int waitsecs;
488extern unsigned int encoder_buffers;
489extern unsigned int vbi_buffers;
490
491/* ----------------------------------------------------------- */
492/* saa7164-core.c                                              */
493void saa7164_dumpregs(struct saa7164_dev *dev, u32 addr);
494void saa7164_getfirmwarestatus(struct saa7164_dev *dev);
495u32 saa7164_getcurrentfirmwareversion(struct saa7164_dev *dev);
496void saa7164_histogram_update(struct saa7164_histogram *hg, u32 val);
497
498/* ----------------------------------------------------------- */
499/* saa7164-fw.c                                                */
500int saa7164_downloadfirmware(struct saa7164_dev *dev);
501
502/* ----------------------------------------------------------- */
503/* saa7164-i2c.c                                               */
504extern int saa7164_i2c_register(struct saa7164_i2c *bus);
505extern int saa7164_i2c_unregister(struct saa7164_i2c *bus);
506
507/* ----------------------------------------------------------- */
508/* saa7164-bus.c                                               */
509int saa7164_bus_setup(struct saa7164_dev *dev);
510void saa7164_bus_dump(struct saa7164_dev *dev);
511int saa7164_bus_set(struct saa7164_dev *dev, struct tmComResInfo* msg,
512	void *buf);
513int saa7164_bus_get(struct saa7164_dev *dev, struct tmComResInfo* msg,
514	void *buf, int peekonly);
515
516/* ----------------------------------------------------------- */
517/* saa7164-cmd.c                                               */
518int saa7164_cmd_send(struct saa7164_dev *dev,
519	u8 id, enum tmComResCmd command, u16 controlselector,
520	u16 size, void *buf);
521int saa7164_irq_dequeue(struct saa7164_dev *dev);
522
523/* ----------------------------------------------------------- */
524/* saa7164-api.c                                               */
525int saa7164_api_get_fw_version(struct saa7164_dev *dev, u32 *version);
526int saa7164_api_enum_subdevs(struct saa7164_dev *dev);
527int saa7164_api_i2c_read(struct saa7164_i2c *bus, u8 addr, u32 reglen, u8 *reg,
528	u32 datalen, u8 *data);
529int saa7164_api_i2c_write(struct saa7164_i2c *bus, u8 addr,
530	u32 datalen, u8 *data);
531int saa7164_api_dif_write(struct saa7164_i2c *bus, u8 addr,
532	u32 datalen, u8 *data);
533int saa7164_api_read_eeprom(struct saa7164_dev *dev, u8 *buf, int buflen);
534int saa7164_api_set_gpiobit(struct saa7164_dev *dev, u8 unitid, u8 pin);
535int saa7164_api_clear_gpiobit(struct saa7164_dev *dev, u8 unitid, u8 pin);
536int saa7164_api_transition_port(struct saa7164_port *port, u8 mode);
537int saa7164_api_initialize_dif(struct saa7164_port *port);
538int saa7164_api_configure_dif(struct saa7164_port *port, u32 std);
539int saa7164_api_set_encoder(struct saa7164_port *port);
540int saa7164_api_get_encoder(struct saa7164_port *port);
541int saa7164_api_set_aspect_ratio(struct saa7164_port *port);
542int saa7164_api_set_usercontrol(struct saa7164_port *port, u8 ctl);
543int saa7164_api_get_usercontrol(struct saa7164_port *port, u8 ctl);
544int saa7164_api_set_videomux(struct saa7164_port *port);
545int saa7164_api_audio_mute(struct saa7164_port *port, int mute);
546int saa7164_api_set_audio_volume(struct saa7164_port *port, s8 level);
547int saa7164_api_set_audio_std(struct saa7164_port *port);
548int saa7164_api_set_audio_detection(struct saa7164_port *port, int autodetect);
549int saa7164_api_get_videomux(struct saa7164_port *port);
550int saa7164_api_set_vbi_format(struct saa7164_port *port);
551int saa7164_api_set_debug(struct saa7164_dev *dev, u8 level);
552int saa7164_api_collect_debug(struct saa7164_dev *dev);
553int saa7164_api_get_load_info(struct saa7164_dev *dev,
554	struct tmFwInfoStruct *i);
555
556/* ----------------------------------------------------------- */
557/* saa7164-cards.c                                             */
558extern struct saa7164_board saa7164_boards[];
559extern const unsigned int saa7164_bcount;
560
561extern struct saa7164_subid saa7164_subids[];
562extern const unsigned int saa7164_idcount;
563
564extern void saa7164_card_list(struct saa7164_dev *dev);
565extern void saa7164_gpio_setup(struct saa7164_dev *dev);
566extern void saa7164_card_setup(struct saa7164_dev *dev);
567
568extern int saa7164_i2caddr_to_reglen(struct saa7164_i2c *bus, int addr);
569extern int saa7164_i2caddr_to_unitid(struct saa7164_i2c *bus, int addr);
570extern char *saa7164_unitid_name(struct saa7164_dev *dev, u8 unitid);
571
572/* ----------------------------------------------------------- */
573/* saa7164-dvb.c                                               */
574extern int saa7164_dvb_register(struct saa7164_port *port);
575extern int saa7164_dvb_unregister(struct saa7164_port *port);
576
577/* ----------------------------------------------------------- */
578/* saa7164-buffer.c                                            */
579extern struct saa7164_buffer *saa7164_buffer_alloc(
580	struct saa7164_port *port, u32 len);
581extern int saa7164_buffer_dealloc(struct saa7164_buffer *buf);
582extern int saa7164_buffer_activate(struct saa7164_buffer *buf, int i);
583extern int saa7164_buffer_cfg_port(struct saa7164_port *port);
584extern struct saa7164_user_buffer *saa7164_buffer_alloc_user(
585	struct saa7164_dev *dev, u32 len);
586extern void saa7164_buffer_dealloc_user(struct saa7164_user_buffer *buf);
587extern int saa7164_buffer_zero_offsets(struct saa7164_port *port, int i);
588
589/* ----------------------------------------------------------- */
590/* saa7164-encoder.c                                            */
591int saa7164_s_std(struct saa7164_port *port, v4l2_std_id id);
592int saa7164_g_std(struct saa7164_port *port, v4l2_std_id *id);
593int saa7164_enum_input(struct file *file, void *priv, struct v4l2_input *i);
594int saa7164_g_input(struct saa7164_port *port, unsigned int *i);
595int saa7164_s_input(struct saa7164_port *port, unsigned int i);
596int saa7164_g_tuner(struct file *file, void *priv, struct v4l2_tuner *t);
597int saa7164_s_tuner(struct file *file, void *priv, const struct v4l2_tuner *t);
598int saa7164_g_frequency(struct saa7164_port *port, struct v4l2_frequency *f);
599int saa7164_s_frequency(struct saa7164_port *port,
600			const struct v4l2_frequency *f);
601int saa7164_encoder_register(struct saa7164_port *port);
602void saa7164_encoder_unregister(struct saa7164_port *port);
603
604/* ----------------------------------------------------------- */
605/* saa7164-vbi.c                                            */
606int saa7164_vbi_register(struct saa7164_port *port);
607void saa7164_vbi_unregister(struct saa7164_port *port);
608
609/* ----------------------------------------------------------- */
610
611extern unsigned int crc_checking;
612
613extern unsigned int saa_debug;
614#define dprintk(level, fmt, arg...)\
615	do { if (saa_debug & level)\
616		printk(KERN_DEBUG "%s: " fmt, dev->name, ## arg);\
617	} while (0)
618
619#define log_warn(fmt, arg...)\
620	do { \
621		printk(KERN_WARNING "%s: " fmt, dev->name, ## arg);\
622	} while (0)
623
624#define saa7164_readl(reg) readl(dev->lmmio + ((reg) >> 2))
625#define saa7164_writel(reg, value) writel((value), dev->lmmio + ((reg) >> 2))
626
627#define saa7164_readb(reg)             readl(dev->bmmio + (reg))
628#define saa7164_writeb(reg, value)     writel((value), dev->bmmio + (reg))
629