V4L/DVB (8309): sms1xxx: fix OOPS on 64 bit kernels due to a bad cast
[deliverable/linux.git] / drivers / media / dvb / siano / smscoreapi.h
CommitLineData
8d4f9d0e 1/*
85447060 2 * Driver for the Siano SMS1xxx USB dongle
8d4f9d0e 3 *
85447060
MK
4 * author: Anatoly Greenblat
5 *
6 * Copyright (c), 2005-2008 Siano Mobile Silicon, Inc.
8d4f9d0e
ST
7 *
8 * This program is free software; you can redistribute it and/or modify
85447060
MK
9 * it under the terms of the GNU General Public License version 3 as
10 * published by the Free Software Foundation;
8d4f9d0e 11 *
85447060
MK
12 * Software distributed under the License is distributed on an "AS IS"
13 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
8d4f9d0e 14 *
85447060 15 * See the GNU General Public License for more details.
8d4f9d0e
ST
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 */
21
2e5c1ec8
MK
22#ifndef __smscoreapi_h__
23#define __smscoreapi_h__
24
955e9ca3
ST
25#include <linux/version.h>
26#include <linux/device.h>
27#include <linux/list.h>
28#include <linux/mm.h>
29#include <asm/scatterlist.h>
30#include <asm/page.h>
31
19d703da
ST
32#include "dmxdev.h"
33#include "dvbdev.h"
34#include "dvb_demux.h"
35#include "dvb_frontend.h"
36
955e9ca3
ST
37#include <linux/mutex.h>
38
39typedef struct mutex kmutex_t;
40
41#define kmutex_init(_p_) mutex_init(_p_)
42#define kmutex_lock(_p_) mutex_lock(_p_)
43#define kmutex_trylock(_p_) mutex_trylock(_p_)
44#define kmutex_unlock(_p_) mutex_unlock(_p_)
45
2e5c1ec8 46#ifndef min
fa830e8a 47#define min(a, b) (((a) < (b)) ? (a) : (b))
2e5c1ec8
MK
48#endif
49
50#define SMS_ALLOC_ALIGNMENT 128
51#define SMS_DMA_ALIGNMENT 16
59bf6b8e 52#define SMS_ALIGN_ADDRESS(addr) \
4411d291 53 ((((uintptr_t)(addr)) + (SMS_DMA_ALIGNMENT-1)) & ~(SMS_DMA_ALIGNMENT-1))
2e5c1ec8
MK
54
55#define SMS_DEVICE_FAMILY2 1
56#define SMS_ROM_NO_RESPONSE 2
57#define SMS_DEVICE_NOT_READY 0x8000000
58
18245e18 59enum sms_device_type_st {
fa830e8a 60 SMS_STELLAR = 0,
f17407a8
MK
61 SMS_NOVA_A0,
62 SMS_NOVA_B0,
63 SMS_VEGA,
64 SMS_NUM_OF_DEVICE_TYPES
18245e18 65};
f17407a8 66
18245e18
MK
67struct smscore_device_t;
68struct smscore_client_t;
69struct smscore_buffer_t;
2e5c1ec8 70
18245e18 71typedef int (*hotplug_t)(struct smscore_device_t *coredev,
59bf6b8e 72 struct device *device, int arrival);
2e5c1ec8
MK
73
74typedef int (*setmode_t)(void *context, int mode);
75typedef void (*detectmode_t)(void *context, int *mode);
76typedef int (*sendrequest_t)(void *context, void *buffer, size_t size);
77typedef int (*loadfirmware_t)(void *context, void *buffer, size_t size);
78typedef int (*preload_t)(void *context);
79typedef int (*postload_t)(void *context);
80
18245e18 81typedef int (*onresponse_t)(void *context, struct smscore_buffer_t *cb);
2e5c1ec8
MK
82typedef void (*onremove_t)(void *context);
83
18245e18 84struct smscore_buffer_t {
82237416 85 /* public members, once passed to clients can be changed freely */
2e5c1ec8
MK
86 struct list_head entry;
87 int size;
88 int offset;
89
82237416 90 /* private members, read-only for clients */
2e5c1ec8
MK
91 void *p;
92 dma_addr_t phys;
93 unsigned long offset_in_common;
18245e18 94};
2e5c1ec8 95
18245e18 96struct smsdevice_params_t {
2e5c1ec8
MK
97 struct device *device;
98
99 int buffer_size;
100 int num_buffers;
101
102 char devpath[32];
103 unsigned long flags;
104
105 setmode_t setmode_handler;
106 detectmode_t detectmode_handler;
107 sendrequest_t sendrequest_handler;
108 preload_t preload_handler;
109 postload_t postload_handler;
110
111 void *context;
18245e18
MK
112 enum sms_device_type_st device_type;
113};
2e5c1ec8 114
18245e18 115struct smsclient_params_t {
2e5c1ec8
MK
116 int initial_id;
117 int data_type;
118 onresponse_t onresponse_handler;
119 onremove_t onremove_handler;
120
121 void *context;
18245e18 122};
2e5c1ec8 123
82237416 124/* GPIO definitions for antenna frequency domain control (SMS8021) */
9e4fb5e7
ST
125#define SMS_ANTENNA_GPIO_0 1
126#define SMS_ANTENNA_GPIO_1 0
127
128#define BW_8_MHZ 0
129#define BW_7_MHZ 1
130#define BW_6_MHZ 2
131#define BW_5_MHZ 3
132#define BW_ISDBT_1SEG 4
133#define BW_ISDBT_3SEG 5
134
135#define MSG_HDR_FLAG_SPLIT_MSG 4
136
137#define MAX_GPIO_PIN_NUMBER 31
138
139#define HIF_TASK 11
140#define SMS_HOST_LIB 150
141#define DVBT_BDA_CONTROL_MSG_ID 201
142
143#define SMS_MAX_PAYLOAD_SIZE 240
144#define SMS_TUNE_TIMEOUT 500
145
146#define MSG_SMS_GPIO_CONFIG_REQ 507
147#define MSG_SMS_GPIO_CONFIG_RES 508
148#define MSG_SMS_GPIO_SET_LEVEL_REQ 509
149#define MSG_SMS_GPIO_SET_LEVEL_RES 510
150#define MSG_SMS_GPIO_GET_LEVEL_REQ 511
151#define MSG_SMS_GPIO_GET_LEVEL_RES 512
152#define MSG_SMS_RF_TUNE_REQ 561
153#define MSG_SMS_RF_TUNE_RES 562
154#define MSG_SMS_INIT_DEVICE_REQ 578
155#define MSG_SMS_INIT_DEVICE_RES 579
156#define MSG_SMS_ADD_PID_FILTER_REQ 601
157#define MSG_SMS_ADD_PID_FILTER_RES 602
158#define MSG_SMS_REMOVE_PID_FILTER_REQ 603
159#define MSG_SMS_REMOVE_PID_FILTER_RES 604
160#define MSG_SMS_DAB_CHANNEL 607
161#define MSG_SMS_GET_PID_FILTER_LIST_REQ 608
162#define MSG_SMS_GET_PID_FILTER_LIST_RES 609
163#define MSG_SMS_GET_STATISTICS_REQ 615
164#define MSG_SMS_GET_STATISTICS_RES 616
165#define MSG_SMS_SET_ANTENNA_CONFIG_REQ 651
166#define MSG_SMS_SET_ANTENNA_CONFIG_RES 652
167#define MSG_SMS_GET_STATISTICS_EX_REQ 653
168#define MSG_SMS_GET_STATISTICS_EX_RES 654
169#define MSG_SMS_SLEEP_RESUME_COMP_IND 655
170#define MSG_SMS_DATA_DOWNLOAD_REQ 660
171#define MSG_SMS_DATA_DOWNLOAD_RES 661
172#define MSG_SMS_SWDOWNLOAD_TRIGGER_REQ 664
173#define MSG_SMS_SWDOWNLOAD_TRIGGER_RES 665
174#define MSG_SMS_SWDOWNLOAD_BACKDOOR_REQ 666
175#define MSG_SMS_SWDOWNLOAD_BACKDOOR_RES 667
176#define MSG_SMS_GET_VERSION_EX_REQ 668
177#define MSG_SMS_GET_VERSION_EX_RES 669
178#define MSG_SMS_SET_CLOCK_OUTPUT_REQ 670
179#define MSG_SMS_I2C_SET_FREQ_REQ 685
180#define MSG_SMS_GENERIC_I2C_REQ 687
181#define MSG_SMS_GENERIC_I2C_RES 688
182#define MSG_SMS_DVBT_BDA_DATA 693
183#define MSG_SW_RELOAD_REQ 697
184#define MSG_SMS_DATA_MSG 699
185#define MSG_SW_RELOAD_START_REQ 702
186#define MSG_SW_RELOAD_START_RES 703
187#define MSG_SW_RELOAD_EXEC_REQ 704
188#define MSG_SW_RELOAD_EXEC_RES 705
189#define MSG_SMS_SPI_INT_LINE_SET_REQ 710
190#define MSG_SMS_ISDBT_TUNE_REQ 776
191#define MSG_SMS_ISDBT_TUNE_RES 777
192
193#define SMS_INIT_MSG_EX(ptr, type, src, dst, len) do { \
194 (ptr)->msgType = type; (ptr)->msgSrcId = src; (ptr)->msgDstId = dst; \
195 (ptr)->msgLength = len; (ptr)->msgFlags = 0; \
196} while (0)
59bf6b8e
MK
197#define SMS_INIT_MSG(ptr, type, len) \
198 SMS_INIT_MSG_EX(ptr, type, 0, HIF_TASK, len)
9e4fb5e7 199
18245e18 200enum SMS_DEVICE_MODE {
9e4fb5e7
ST
201 DEVICE_MODE_NONE = -1,
202 DEVICE_MODE_DVBT = 0,
203 DEVICE_MODE_DVBH,
204 DEVICE_MODE_DAB_TDMB,
205 DEVICE_MODE_DAB_TDMB_DABIP,
206 DEVICE_MODE_DVBT_BDA,
207 DEVICE_MODE_ISDBT,
208 DEVICE_MODE_ISDBT_BDA,
209 DEVICE_MODE_CMMB,
210 DEVICE_MODE_RAW_TUNER,
211 DEVICE_MODE_MAX,
18245e18 212};
9e4fb5e7 213
18245e18 214struct SmsMsgHdr_ST {
f0333e3d
MK
215 u16 msgType;
216 u8 msgSrcId;
217 u8 msgDstId;
218 u16 msgLength; /* Length of entire message, including header */
219 u16 msgFlags;
18245e18 220};
9e4fb5e7 221
18245e18
MK
222struct SmsMsgData_ST {
223 struct SmsMsgHdr_ST xMsgHeader;
f0333e3d 224 u32 msgData[1];
18245e18 225};
9e4fb5e7 226
18245e18
MK
227struct SmsDataDownload_ST {
228 struct SmsMsgHdr_ST xMsgHeader;
f0333e3d
MK
229 u32 MemAddr;
230 u8 Payload[SMS_MAX_PAYLOAD_SIZE];
18245e18 231};
9e4fb5e7 232
18245e18
MK
233struct SmsVersionRes_ST {
234 struct SmsMsgHdr_ST xMsgHeader;
9e4fb5e7 235
f0333e3d
MK
236 u16 ChipModel; /* e.g. 0x1102 for SMS-1102 "Nova" */
237 u8 Step; /* 0 - Step A */
238 u8 MetalFix; /* 0 - Metal 0 */
9e4fb5e7 239
59bf6b8e
MK
240 u8 FirmwareId; /* 0xFF � ROM, otherwise the
241 * value indicated by
242 * SMSHOSTLIB_DEVICE_MODES_E */
243 u8 SupportedProtocols; /* Bitwise OR combination of
244 * supported protocols */
9e4fb5e7 245
f0333e3d
MK
246 u8 VersionMajor;
247 u8 VersionMinor;
248 u8 VersionPatch;
249 u8 VersionFieldPatch;
9e4fb5e7 250
f0333e3d
MK
251 u8 RomVersionMajor;
252 u8 RomVersionMinor;
253 u8 RomVersionPatch;
254 u8 RomVersionFieldPatch;
9e4fb5e7 255
f0333e3d 256 u8 TextLabel[34];
18245e18 257};
9e4fb5e7 258
18245e18 259struct SmsFirmware_ST {
f0333e3d
MK
260 u32 CheckSum;
261 u32 Length;
262 u32 StartAddress;
263 u8 Payload[1];
18245e18 264};
9e4fb5e7 265
18245e18 266struct SMSHOSTLIB_STATISTICS_ST {
f0333e3d 267 u32 Reserved; /* Reserved */
82237416
MK
268
269 /* Common parameters */
f0333e3d
MK
270 u32 IsRfLocked; /* 0 - not locked, 1 - locked */
271 u32 IsDemodLocked; /* 0 - not locked, 1 - locked */
272 u32 IsExternalLNAOn; /* 0 - external LNA off, 1 - external LNA on */
82237416
MK
273
274 /* Reception quality */
f0333e3d
MK
275 s32 SNR; /* dB */
276 u32 BER; /* Post Viterbi BER [1E-5] */
277 u32 FIB_CRC; /* CRC errors percentage, valid only for DAB */
59bf6b8e
MK
278 u32 TS_PER; /* Transport stream PER, 0xFFFFFFFF indicate N/A,
279 * valid only for DVB-T/H */
280 u32 MFER; /* DVB-H frame error rate in percentage,
281 * 0xFFFFFFFF indicate N/A, valid only for DVB-H */
f0333e3d
MK
282 s32 RSSI; /* dBm */
283 s32 InBandPwr; /* In band power in dBM */
284 s32 CarrierOffset; /* Carrier Offset in bin/1024 */
82237416 285
59bf6b8e 286 /* Transmission parameters, valid only for DVB-T/H */
f0333e3d 287 u32 Frequency; /* Frequency in Hz */
59bf6b8e
MK
288 u32 Bandwidth; /* Bandwidth in MHz */
289 u32 TransmissionMode; /* Transmission Mode, for DAB modes 1-4,
290 * for DVB-T/H FFT mode carriers in Kilos */
291 u32 ModemState; /* from SMS_DvbModemState_ET */
292 u32 GuardInterval; /* Guard Interval, 1 divided by value */
293 u32 CodeRate; /* Code Rate from SMS_DvbModemState_ET */
294 u32 LPCodeRate; /* Low Priority Code Rate from SMS_DvbModemState_ET */
295 u32 Hierarchy; /* Hierarchy from SMS_Hierarchy_ET */
296 u32 Constellation; /* Constellation from SMS_Constellation_ET */
82237416
MK
297
298 /* Burst parameters, valid only for DVB-H */
59bf6b8e
MK
299 u32 BurstSize; /* Current burst size in bytes */
300 u32 BurstDuration; /* Current burst duration in mSec */
301 u32 BurstCycleTime; /* Current burst cycle time in mSec */
302 u32 CalculatedBurstCycleTime; /* Current burst cycle time in mSec,
303 * as calculated by demodulator */
304 u32 NumOfRows; /* Number of rows in MPE table */
305 u32 NumOfPaddCols; /* Number of padding columns in MPE table */
306 u32 NumOfPunctCols; /* Number of puncturing columns in MPE table */
307 /* Burst parameters */
f0333e3d
MK
308 u32 ErrorTSPackets; /* Number of erroneous transport-stream packets */
309 u32 TotalTSPackets; /* Total number of transport-stream packets */
59bf6b8e
MK
310 u32 NumOfValidMpeTlbs; /* Number of MPE tables which do not include
311 * errors after MPE RS decoding */
312 u32 NumOfInvalidMpeTlbs; /* Number of MPE tables which include errors
313 * after MPE RS decoding */
314 u32 NumOfCorrectedMpeTlbs; /* Number of MPE tables which were corrected
315 * by MPE RS decoding */
82237416
MK
316
317 /* Common params */
f0333e3d
MK
318 u32 BERErrorCount; /* Number of errornous SYNC bits. */
319 u32 BERBitCount; /* Total number of SYNC bits. */
82237416
MK
320
321 /* Interface information */
f0333e3d 322 u32 SmsToHostTxErrors; /* Total number of transmission errors. */
82237416
MK
323
324 /* DAB/T-DMB */
f0333e3d 325 u32 PreBER; /* DAB/T-DMB only: Pre Viterbi BER [1E-5] */
82237416
MK
326
327 /* DVB-H TPS parameters */
59bf6b8e
MK
328 u32 CellId; /* TPS Cell ID in bits 15..0, bits 31..16 zero;
329 * if set to 0xFFFFFFFF cell_id not yet recovered */
9e4fb5e7 330
18245e18 331};
9e4fb5e7 332
18245e18 333struct SmsMsgStatisticsInfo_ST {
f0333e3d 334 u32 RequestResult;
9e4fb5e7 335
18245e18 336 struct SMSHOSTLIB_STATISTICS_ST Stat;
9e4fb5e7 337
82237416 338 /* Split the calc of the SNR in DAB */
f0333e3d
MK
339 u32 Signal; /* dB */
340 u32 Noise; /* dB */
9e4fb5e7 341
18245e18 342};
82237416 343
9e4fb5e7 344
18245e18 345struct smsdvb_client_t {
3dd24378
ST
346 struct list_head entry;
347
18245e18
MK
348 struct smscore_device_t *coredev;
349 struct smscore_client_t *smsclient;
3dd24378
ST
350
351 struct dvb_adapter adapter;
352 struct dvb_demux demux;
353 struct dmxdev dmxdev;
354 struct dvb_frontend frontend;
355
82237416
MK
356 fe_status_t fe_status;
357 int fe_ber, fe_snr, fe_signal_strength;
3dd24378
ST
358
359 struct completion tune_done, stat_done;
360
82237416 361 /* todo: save freq/band instead whole struct */
3dd24378
ST
362 struct dvb_frontend_parameters fe_params;
363
18245e18 364};
3dd24378 365
2e5c1ec8
MK
366extern void smscore_registry_setmode(char *devpath, int mode);
367extern int smscore_registry_getmode(char *devpath);
368
369extern int smscore_register_hotplug(hotplug_t hotplug);
370extern void smscore_unregister_hotplug(hotplug_t hotplug);
371
18245e18
MK
372extern int smscore_register_device(struct smsdevice_params_t *params,
373 struct smscore_device_t **coredev);
374extern void smscore_unregister_device(struct smscore_device_t *coredev);
2e5c1ec8 375
18245e18
MK
376extern int smscore_start_device(struct smscore_device_t *coredev);
377extern int smscore_load_firmware(struct smscore_device_t *coredev,
378 char *filename,
379 loadfirmware_t loadfirmware_handler);
2e5c1ec8 380
18245e18
MK
381extern int smscore_set_device_mode(struct smscore_device_t *coredev, int mode);
382extern int smscore_get_device_mode(struct smscore_device_t *coredev);
2e5c1ec8 383
18245e18
MK
384extern int smscore_register_client(struct smscore_device_t *coredev,
385 struct smsclient_params_t *params,
386 struct smscore_client_t **client);
387extern void smscore_unregister_client(struct smscore_client_t *client);
2e5c1ec8 388
18245e18 389extern int smsclient_sendrequest(struct smscore_client_t *client,
82237416 390 void *buffer, size_t size);
18245e18
MK
391extern void smscore_onresponse(struct smscore_device_t *coredev,
392 struct smscore_buffer_t *cb);
2e5c1ec8 393
2e5c1ec8 394
18245e18
MK
395extern struct smscore_buffer_t *smscore_getbuffer(struct smscore_device_t *coredev);
396extern void smscore_putbuffer(struct smscore_device_t *coredev,
397 struct smscore_buffer_t *cb);
2e5c1ec8 398
1c11d546
MK
399void smscore_set_board_id(struct smscore_device_t *core, int id);
400int smscore_get_board_id(struct smscore_device_t *core);
401
3dd24378 402/* smsdvb.c */
eae55660
ST
403int smsdvb_register(void);
404void smsdvb_unregister(void);
405
406/* smsusb.c */
407int smsusb_register(void);
408void smsusb_unregister(void);
3dd24378 409
f14d56a9
MK
410/* ------------------------------------------------------------------------ */
411
412extern int sms_debug;
413
414#define DBG_INFO 1
415#define DBG_ADV 2
416
417#define sms_printk(kern, fmt, arg...) \
418 printk(kern "%s: " fmt "\n", __func__, ##arg)
419
420#define dprintk(kern, lvl, fmt, arg...) do {\
421 if (sms_debug & lvl) \
422 sms_printk(kern, fmt, ##arg); } while (0)
423
5068b7a4 424#define sms_log(fmt, arg...) sms_printk(KERN_INFO, fmt, ##arg)
a0c0abcb 425#define sms_err(fmt, arg...) \
c65c7a65 426 sms_printk(KERN_ERR, "line: %d: " fmt, __LINE__, ##arg)
5068b7a4 427#define sms_warn(fmt, arg...) sms_printk(KERN_WARNING, fmt, ##arg)
a0c0abcb 428#define sms_info(fmt, arg...) \
f14d56a9 429 dprintk(KERN_INFO, DBG_INFO, fmt, ##arg)
a0c0abcb 430#define sms_debug(fmt, arg...) \
f14d56a9 431 dprintk(KERN_DEBUG, DBG_ADV, fmt, ##arg)
068d6c0f
MK
432
433
82237416 434#endif /* __smscoreapi_h__ */
This page took 0.04995 seconds and 5 git commands to generate.