2 * Driver for the Siano SMS1xxx USB dongle
4 * author: Anatoly Greenblat
6 * Copyright (c), 2005-2008 Siano Mobile Silicon, Inc.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 3 as
10 * published by the Free Software Foundation;
12 * Software distributed under the License is distributed on an "AS IS"
13 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
15 * See the GNU General Public License for more details.
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.
22 #ifndef __smscoreapi_h__
23 #define __smscoreapi_h__
25 #include <linux/version.h>
26 #include <linux/device.h>
27 #include <linux/list.h>
29 #include <asm/scatterlist.h>
34 #include "dvb_demux.h"
35 #include "dvb_frontend.h"
37 #include <linux/mutex.h>
39 typedef struct mutex kmutex_t
;
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_)
48 #define min(a, b) (((a) < (b)) ? (a) : (b))
51 #define SMS_ALLOC_ALIGNMENT 128
52 #define SMS_DMA_ALIGNMENT 16
53 #define SMS_ALIGN_ADDRESS(addr) \
54 ((((u32)(addr)) + (SMS_DMA_ALIGNMENT-1)) & ~(SMS_DMA_ALIGNMENT-1))
56 #define SMS_DEVICE_FAMILY2 1
57 #define SMS_ROM_NO_RESPONSE 2
58 #define SMS_DEVICE_NOT_READY 0x8000000
60 enum sms_device_type_st
{
65 SMS_NUM_OF_DEVICE_TYPES
68 struct smscore_device_t
;
69 struct smscore_client_t
;
70 struct smscore_buffer_t
;
72 typedef int (*hotplug_t
)(struct smscore_device_t
*coredev
,
73 struct device
*device
, int arrival
);
75 typedef int (*setmode_t
)(void *context
, int mode
);
76 typedef void (*detectmode_t
)(void *context
, int *mode
);
77 typedef int (*sendrequest_t
)(void *context
, void *buffer
, size_t size
);
78 typedef int (*loadfirmware_t
)(void *context
, void *buffer
, size_t size
);
79 typedef int (*preload_t
)(void *context
);
80 typedef int (*postload_t
)(void *context
);
82 typedef int (*onresponse_t
)(void *context
, struct smscore_buffer_t
*cb
);
83 typedef void (*onremove_t
)(void *context
);
85 struct smscore_buffer_t
{
86 /* public members, once passed to clients can be changed freely */
87 struct list_head entry
;
91 /* private members, read-only for clients */
94 unsigned long offset_in_common
;
97 struct smsdevice_params_t
{
98 struct device
*device
;
106 setmode_t setmode_handler
;
107 detectmode_t detectmode_handler
;
108 sendrequest_t sendrequest_handler
;
109 preload_t preload_handler
;
110 postload_t postload_handler
;
113 enum sms_device_type_st device_type
;
116 struct smsclient_params_t
{
119 onresponse_t onresponse_handler
;
120 onremove_t onremove_handler
;
125 /* GPIO definitions for antenna frequency domain control (SMS8021) */
126 #define SMS_ANTENNA_GPIO_0 1
127 #define SMS_ANTENNA_GPIO_1 0
133 #define BW_ISDBT_1SEG 4
134 #define BW_ISDBT_3SEG 5
136 #define MSG_HDR_FLAG_SPLIT_MSG 4
138 #define MAX_GPIO_PIN_NUMBER 31
141 #define SMS_HOST_LIB 150
142 #define DVBT_BDA_CONTROL_MSG_ID 201
144 #define SMS_MAX_PAYLOAD_SIZE 240
145 #define SMS_TUNE_TIMEOUT 500
147 #define MSG_SMS_GPIO_CONFIG_REQ 507
148 #define MSG_SMS_GPIO_CONFIG_RES 508
149 #define MSG_SMS_GPIO_SET_LEVEL_REQ 509
150 #define MSG_SMS_GPIO_SET_LEVEL_RES 510
151 #define MSG_SMS_GPIO_GET_LEVEL_REQ 511
152 #define MSG_SMS_GPIO_GET_LEVEL_RES 512
153 #define MSG_SMS_RF_TUNE_REQ 561
154 #define MSG_SMS_RF_TUNE_RES 562
155 #define MSG_SMS_INIT_DEVICE_REQ 578
156 #define MSG_SMS_INIT_DEVICE_RES 579
157 #define MSG_SMS_ADD_PID_FILTER_REQ 601
158 #define MSG_SMS_ADD_PID_FILTER_RES 602
159 #define MSG_SMS_REMOVE_PID_FILTER_REQ 603
160 #define MSG_SMS_REMOVE_PID_FILTER_RES 604
161 #define MSG_SMS_DAB_CHANNEL 607
162 #define MSG_SMS_GET_PID_FILTER_LIST_REQ 608
163 #define MSG_SMS_GET_PID_FILTER_LIST_RES 609
164 #define MSG_SMS_GET_STATISTICS_REQ 615
165 #define MSG_SMS_GET_STATISTICS_RES 616
166 #define MSG_SMS_SET_ANTENNA_CONFIG_REQ 651
167 #define MSG_SMS_SET_ANTENNA_CONFIG_RES 652
168 #define MSG_SMS_GET_STATISTICS_EX_REQ 653
169 #define MSG_SMS_GET_STATISTICS_EX_RES 654
170 #define MSG_SMS_SLEEP_RESUME_COMP_IND 655
171 #define MSG_SMS_DATA_DOWNLOAD_REQ 660
172 #define MSG_SMS_DATA_DOWNLOAD_RES 661
173 #define MSG_SMS_SWDOWNLOAD_TRIGGER_REQ 664
174 #define MSG_SMS_SWDOWNLOAD_TRIGGER_RES 665
175 #define MSG_SMS_SWDOWNLOAD_BACKDOOR_REQ 666
176 #define MSG_SMS_SWDOWNLOAD_BACKDOOR_RES 667
177 #define MSG_SMS_GET_VERSION_EX_REQ 668
178 #define MSG_SMS_GET_VERSION_EX_RES 669
179 #define MSG_SMS_SET_CLOCK_OUTPUT_REQ 670
180 #define MSG_SMS_I2C_SET_FREQ_REQ 685
181 #define MSG_SMS_GENERIC_I2C_REQ 687
182 #define MSG_SMS_GENERIC_I2C_RES 688
183 #define MSG_SMS_DVBT_BDA_DATA 693
184 #define MSG_SW_RELOAD_REQ 697
185 #define MSG_SMS_DATA_MSG 699
186 #define MSG_SW_RELOAD_START_REQ 702
187 #define MSG_SW_RELOAD_START_RES 703
188 #define MSG_SW_RELOAD_EXEC_REQ 704
189 #define MSG_SW_RELOAD_EXEC_RES 705
190 #define MSG_SMS_SPI_INT_LINE_SET_REQ 710
191 #define MSG_SMS_ISDBT_TUNE_REQ 776
192 #define MSG_SMS_ISDBT_TUNE_RES 777
194 #define SMS_INIT_MSG_EX(ptr, type, src, dst, len) do { \
195 (ptr)->msgType = type; (ptr)->msgSrcId = src; (ptr)->msgDstId = dst; \
196 (ptr)->msgLength = len; (ptr)->msgFlags = 0; \
198 #define SMS_INIT_MSG(ptr, type, len) \
199 SMS_INIT_MSG_EX(ptr, type, 0, HIF_TASK, len)
201 enum SMS_DEVICE_MODE
{
202 DEVICE_MODE_NONE
= -1,
203 DEVICE_MODE_DVBT
= 0,
205 DEVICE_MODE_DAB_TDMB
,
206 DEVICE_MODE_DAB_TDMB_DABIP
,
207 DEVICE_MODE_DVBT_BDA
,
209 DEVICE_MODE_ISDBT_BDA
,
211 DEVICE_MODE_RAW_TUNER
,
215 struct SmsMsgHdr_ST
{
219 u16 msgLength
; /* Length of entire message, including header */
223 struct SmsMsgData_ST
{
224 struct SmsMsgHdr_ST xMsgHeader
;
228 struct SmsDataDownload_ST
{
229 struct SmsMsgHdr_ST xMsgHeader
;
231 u8 Payload
[SMS_MAX_PAYLOAD_SIZE
];
234 struct SmsVersionRes_ST
{
235 struct SmsMsgHdr_ST xMsgHeader
;
237 u16 ChipModel
; /* e.g. 0x1102 for SMS-1102 "Nova" */
238 u8 Step
; /* 0 - Step A */
239 u8 MetalFix
; /* 0 - Metal 0 */
241 u8 FirmwareId
; /* 0xFF � ROM, otherwise the
243 * SMSHOSTLIB_DEVICE_MODES_E */
244 u8 SupportedProtocols
; /* Bitwise OR combination of
245 * supported protocols */
250 u8 VersionFieldPatch
;
255 u8 RomVersionFieldPatch
;
260 struct SmsFirmware_ST
{
267 struct SMSHOSTLIB_STATISTICS_ST
{
268 u32 Reserved
; /* Reserved */
270 /* Common parameters */
271 u32 IsRfLocked
; /* 0 - not locked, 1 - locked */
272 u32 IsDemodLocked
; /* 0 - not locked, 1 - locked */
273 u32 IsExternalLNAOn
; /* 0 - external LNA off, 1 - external LNA on */
275 /* Reception quality */
277 u32 BER
; /* Post Viterbi BER [1E-5] */
278 u32 FIB_CRC
; /* CRC errors percentage, valid only for DAB */
279 u32 TS_PER
; /* Transport stream PER, 0xFFFFFFFF indicate N/A,
280 * valid only for DVB-T/H */
281 u32 MFER
; /* DVB-H frame error rate in percentage,
282 * 0xFFFFFFFF indicate N/A, valid only for DVB-H */
284 s32 InBandPwr
; /* In band power in dBM */
285 s32 CarrierOffset
; /* Carrier Offset in bin/1024 */
287 /* Transmission parameters, valid only for DVB-T/H */
288 u32 Frequency
; /* Frequency in Hz */
289 u32 Bandwidth
; /* Bandwidth in MHz */
290 u32 TransmissionMode
; /* Transmission Mode, for DAB modes 1-4,
291 * for DVB-T/H FFT mode carriers in Kilos */
292 u32 ModemState
; /* from SMS_DvbModemState_ET */
293 u32 GuardInterval
; /* Guard Interval, 1 divided by value */
294 u32 CodeRate
; /* Code Rate from SMS_DvbModemState_ET */
295 u32 LPCodeRate
; /* Low Priority Code Rate from SMS_DvbModemState_ET */
296 u32 Hierarchy
; /* Hierarchy from SMS_Hierarchy_ET */
297 u32 Constellation
; /* Constellation from SMS_Constellation_ET */
299 /* Burst parameters, valid only for DVB-H */
300 u32 BurstSize
; /* Current burst size in bytes */
301 u32 BurstDuration
; /* Current burst duration in mSec */
302 u32 BurstCycleTime
; /* Current burst cycle time in mSec */
303 u32 CalculatedBurstCycleTime
; /* Current burst cycle time in mSec,
304 * as calculated by demodulator */
305 u32 NumOfRows
; /* Number of rows in MPE table */
306 u32 NumOfPaddCols
; /* Number of padding columns in MPE table */
307 u32 NumOfPunctCols
; /* Number of puncturing columns in MPE table */
308 /* Burst parameters */
309 u32 ErrorTSPackets
; /* Number of erroneous transport-stream packets */
310 u32 TotalTSPackets
; /* Total number of transport-stream packets */
311 u32 NumOfValidMpeTlbs
; /* Number of MPE tables which do not include
312 * errors after MPE RS decoding */
313 u32 NumOfInvalidMpeTlbs
; /* Number of MPE tables which include errors
314 * after MPE RS decoding */
315 u32 NumOfCorrectedMpeTlbs
; /* Number of MPE tables which were corrected
316 * by MPE RS decoding */
319 u32 BERErrorCount
; /* Number of errornous SYNC bits. */
320 u32 BERBitCount
; /* Total number of SYNC bits. */
322 /* Interface information */
323 u32 SmsToHostTxErrors
; /* Total number of transmission errors. */
326 u32 PreBER
; /* DAB/T-DMB only: Pre Viterbi BER [1E-5] */
328 /* DVB-H TPS parameters */
329 u32 CellId
; /* TPS Cell ID in bits 15..0, bits 31..16 zero;
330 * if set to 0xFFFFFFFF cell_id not yet recovered */
334 struct SmsMsgStatisticsInfo_ST
{
337 struct SMSHOSTLIB_STATISTICS_ST Stat
;
339 /* Split the calc of the SNR in DAB */
346 struct smsdvb_client_t
{
347 struct list_head entry
;
349 struct smscore_device_t
*coredev
;
350 struct smscore_client_t
*smsclient
;
352 struct dvb_adapter adapter
;
353 struct dvb_demux demux
;
354 struct dmxdev dmxdev
;
355 struct dvb_frontend frontend
;
357 fe_status_t fe_status
;
358 int fe_ber
, fe_snr
, fe_signal_strength
;
360 struct completion tune_done
, stat_done
;
362 /* todo: save freq/band instead whole struct */
363 struct dvb_frontend_parameters fe_params
;
367 extern void smscore_registry_setmode(char *devpath
, int mode
);
368 extern int smscore_registry_getmode(char *devpath
);
370 extern int smscore_register_hotplug(hotplug_t hotplug
);
371 extern void smscore_unregister_hotplug(hotplug_t hotplug
);
373 extern int smscore_register_device(struct smsdevice_params_t
*params
,
374 struct smscore_device_t
**coredev
);
375 extern void smscore_unregister_device(struct smscore_device_t
*coredev
);
377 extern int smscore_start_device(struct smscore_device_t
*coredev
);
378 extern int smscore_load_firmware(struct smscore_device_t
*coredev
,
380 loadfirmware_t loadfirmware_handler
);
382 extern int smscore_load_firmware_from_buffer(struct smscore_device_t
*coredev
,
383 u8
*buffer
, int size
,
386 extern int smscore_set_device_mode(struct smscore_device_t
*coredev
, int mode
);
387 extern int smscore_get_device_mode(struct smscore_device_t
*coredev
);
389 extern int smscore_register_client(struct smscore_device_t
*coredev
,
390 struct smsclient_params_t
*params
,
391 struct smscore_client_t
**client
);
392 extern void smscore_unregister_client(struct smscore_client_t
*client
);
394 extern int smsclient_sendrequest(struct smscore_client_t
*client
,
395 void *buffer
, size_t size
);
396 extern void smscore_onresponse(struct smscore_device_t
*coredev
,
397 struct smscore_buffer_t
*cb
);
399 extern int smscore_get_common_buffer_size(struct smscore_device_t
*coredev
);
400 extern int smscore_map_common_buffer(struct smscore_device_t
*coredev
,
401 struct vm_area_struct
*vma
);
403 extern struct smscore_buffer_t
*smscore_getbuffer(struct smscore_device_t
*coredev
);
404 extern void smscore_putbuffer(struct smscore_device_t
*coredev
,
405 struct smscore_buffer_t
*cb
);
408 int smsdvb_register(void);
409 void smsdvb_unregister(void);
412 int smsusb_register(void);
413 void smsusb_unregister(void);
415 #endif /* __smscoreapi_h__ */