xref: /linux/drivers/media/common/b2c2/flexcop-common.h (revision 552c69b36ebd966186573b9c7a286b390935cce1)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Linux driver for digital TV devices equipped with B2C2 FlexcopII(b)/III
4  * flexcop-common.h - common header file for device-specific source files
5  * see flexcop.c for copyright information
6  */
7 #ifndef __FLEXCOP_COMMON_H__
8 #define __FLEXCOP_COMMON_H__
9 
10 #include <linux/interrupt.h>
11 #include <linux/pci.h>
12 #include <linux/mutex.h>
13 
14 #include "flexcop-reg.h"
15 
16 #include <media/dmxdev.h>
17 #include <media/dvb_demux.h>
18 #include <media/dvb_net.h>
19 #include <media/dvb_frontend.h>
20 
21 #define FC_MAX_FEED 256
22 
23 #ifndef FC_LOG_PREFIX
24 #warning please define a log prefix for your file, using a default one
25 #define FC_LOG_PREFIX "b2c2-undef"
26 #endif
27 
28 /* Steal from usb.h */
29 #undef err
30 #define err(format, arg...) \
31 	printk(KERN_ERR FC_LOG_PREFIX ": " format "\n" , ## arg)
32 #undef info
33 #define info(format, arg...) \
34 	printk(KERN_INFO FC_LOG_PREFIX ": " format "\n" , ## arg)
35 #undef warn
36 #define warn(format, arg...) \
37 	printk(KERN_WARNING FC_LOG_PREFIX ": " format "\n" , ## arg)
38 
39 struct flexcop_dma {
40 	struct pci_dev *pdev;
41 
42 	u8 *cpu_addr0;
43 	dma_addr_t dma_addr0;
44 	u8 *cpu_addr1;
45 	dma_addr_t dma_addr1;
46 	u32 size; /* size of each address in bytes */
47 };
48 
49 struct flexcop_i2c_adapter {
50 	struct flexcop_device *fc;
51 	struct i2c_adapter i2c_adap;
52 
53 	u8 no_base_addr;
54 	flexcop_i2c_port_t port;
55 };
56 
57 /* Control structure for data definitions that are common to
58  * the B2C2-based PCI and USB devices.
59  */
60 struct flexcop_device {
61 	/* general */
62 	struct device *dev; /* for firmware_class */
63 
64 #define FC_STATE_DVB_INIT 0x01
65 #define FC_STATE_I2C_INIT 0x02
66 #define FC_STATE_FE_INIT  0x04
67 	int init_state;
68 
69 	/* device information */
70 	int has_32_hw_pid_filter;
71 	flexcop_revision_t rev;
72 	flexcop_device_type_t dev_type;
73 	flexcop_bus_t bus_type;
74 
75 	/* dvb stuff */
76 	struct dvb_adapter dvb_adapter;
77 	struct dvb_frontend *fe;
78 	struct dvb_net dvbnet;
79 	struct dvb_demux demux;
80 	struct dmxdev dmxdev;
81 	struct dmx_frontend hw_frontend;
82 	struct dmx_frontend mem_frontend;
83 	int (*fe_sleep) (struct dvb_frontend *);
84 
85 	struct flexcop_i2c_adapter fc_i2c_adap[3];
86 	struct mutex i2c_mutex;
87 	struct module *owner;
88 
89 	/* options and status */
90 	int extra_feedcount;
91 	int feedcount;
92 	int pid_filtering;
93 	int fullts_streaming_state;
94 	int skip_6_hw_pid_filter;
95 
96 	/* bus specific callbacks */
97 	flexcop_ibi_value(*read_ibi_reg) (struct flexcop_device *,
98 			flexcop_ibi_register);
99 	int (*write_ibi_reg) (struct flexcop_device *,
100 			flexcop_ibi_register, flexcop_ibi_value);
101 	int (*i2c_request) (struct flexcop_i2c_adapter *,
102 		flexcop_access_op_t, u8 chipaddr, u8 addr, u8 *buf, u16 len);
103 	int (*stream_control) (struct flexcop_device *, int);
104 	int (*get_mac_addr) (struct flexcop_device *fc, int extended);
105 	void *bus_specific;
106 };
107 
108 /* exported prototypes */
109 
110 /* from flexcop.c */
111 void flexcop_pass_dmx_data(struct flexcop_device *fc, u8 *buf, u32 len);
112 void flexcop_pass_dmx_packets(struct flexcop_device *fc, u8 *buf, u32 no);
113 
114 struct flexcop_device *flexcop_device_kmalloc(size_t bus_specific_len);
115 void flexcop_device_kfree(struct flexcop_device *);
116 
117 int flexcop_device_initialize(struct flexcop_device *);
118 void flexcop_device_exit(struct flexcop_device *fc);
119 void flexcop_reset_block_300(struct flexcop_device *fc);
120 
121 /* from flexcop-dma.c */
122 int flexcop_dma_allocate(struct pci_dev *pdev,
123 		struct flexcop_dma *dma, u32 size);
124 void flexcop_dma_free(struct flexcop_dma *dma);
125 
126 int flexcop_dma_control_timer_irq(struct flexcop_device *fc,
127 		flexcop_dma_index_t no, int onoff);
128 int flexcop_dma_control_size_irq(struct flexcop_device *fc,
129 		flexcop_dma_index_t no, int onoff);
130 int flexcop_dma_config(struct flexcop_device *fc, struct flexcop_dma *dma,
131 		flexcop_dma_index_t dma_idx);
132 int flexcop_dma_xfer_control(struct flexcop_device *fc,
133 		flexcop_dma_index_t dma_idx, flexcop_dma_addr_index_t index,
134 		int onoff);
135 int flexcop_dma_config_timer(struct flexcop_device *fc,
136 		flexcop_dma_index_t dma_idx, u8 cycles);
137 
138 /* from flexcop-eeprom.c */
139 /* the PCI part uses this call to get the MAC address, the USB part has its own */
140 int flexcop_eeprom_check_mac_addr(struct flexcop_device *fc, int extended);
141 
142 /* from flexcop-i2c.c */
143 /* the PCI part uses this a i2c_request callback, whereas the usb part has its own
144  * one. We have it in flexcop-i2c.c, because it is going via the actual
145  * I2C-channel of the flexcop.
146  */
147 int flexcop_i2c_request(struct flexcop_i2c_adapter*, flexcop_access_op_t,
148 	u8 chipaddr, u8 addr, u8 *buf, u16 len);
149 
150 /* from flexcop-sram.c */
151 int flexcop_sram_set_dest(struct flexcop_device *fc, flexcop_sram_dest_t dest,
152 	flexcop_sram_dest_target_t target);
153 void flexcop_wan_set_speed(struct flexcop_device *fc, flexcop_wan_speed_t s);
154 void flexcop_sram_ctrl(struct flexcop_device *fc,
155 		int usb_wan, int sramdma, int maximumfill);
156 
157 /* global prototypes for the flexcop-chip */
158 /* from flexcop-fe-tuner.c */
159 int flexcop_frontend_init(struct flexcop_device *fc);
160 void flexcop_frontend_exit(struct flexcop_device *fc);
161 
162 /* from flexcop-i2c.c */
163 int flexcop_i2c_init(struct flexcop_device *fc);
164 void flexcop_i2c_exit(struct flexcop_device *fc);
165 
166 /* from flexcop-sram.c */
167 int flexcop_sram_init(struct flexcop_device *fc);
168 
169 /* from flexcop-misc.c */
170 void flexcop_determine_revision(struct flexcop_device *fc);
171 void flexcop_device_name(struct flexcop_device *fc,
172 		const char *prefix, const char *suffix);
173 void flexcop_dump_reg(struct flexcop_device *fc,
174 		flexcop_ibi_register reg, int num);
175 
176 /* from flexcop-hw-filter.c */
177 int flexcop_pid_feed_control(struct flexcop_device *fc,
178 		struct dvb_demux_feed *dvbdmxfeed, int onoff);
179 void flexcop_hw_filter_init(struct flexcop_device *fc);
180 
181 void flexcop_smc_ctrl(struct flexcop_device *fc, int onoff);
182 
183 void flexcop_set_mac_filter(struct flexcop_device *fc, u8 mac[6]);
184 void flexcop_mac_filter_ctrl(struct flexcop_device *fc, int onoff);
185 
186 #endif
187