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) ((((u32)(addr)) + (SMS_DMA_ALIGNMENT-1)) & ~(SMS_DMA_ALIGNMENT-1))
55 #define SMS_DEVICE_FAMILY2 1
56 #define SMS_ROM_NO_RESPONSE 2
57 #define SMS_DEVICE_NOT_READY 0x8000000
59 typedef struct _smscore_device smscore_device_t;
60 typedef struct _smscore_client smscore_client_t;
61 typedef struct _smscore_buffer smscore_buffer_t;
63 typedef int (*hotplug_t)(smscore_device_t *coredev, struct device *device, int arrival);
65 typedef int (*setmode_t)(void *context, int mode);
66 typedef void (*detectmode_t)(void *context, int *mode);
67 typedef int (*sendrequest_t)(void *context, void *buffer, size_t size);
68 typedef int (*loadfirmware_t)(void *context, void *buffer, size_t size);
69 typedef int (*preload_t)(void *context);
70 typedef int (*postload_t)(void *context);
72 typedef int (*onresponse_t)(void *context, smscore_buffer_t *cb);
73 typedef void (*onremove_t)(void *context);
75 typedef struct _smscore_buffer
77 // public members, once passed to clients can be changed freely
78 struct list_head entry;
82 // private members, read-only for clients
85 unsigned long offset_in_common;
88 typedef struct _smsdevice_params
90 struct device *device;
98 setmode_t setmode_handler;
99 detectmode_t detectmode_handler;
100 sendrequest_t sendrequest_handler;
101 preload_t preload_handler;
102 postload_t postload_handler;
105 } smsdevice_params_t;
107 typedef struct _smsclient_params
111 onresponse_t onresponse_handler;
112 onremove_t onremove_handler;
115 } smsclient_params_t;
117 // GPIO definitions for antenna frequency domain control (SMS8021)
118 #define SMS_ANTENNA_GPIO_0 1
119 #define SMS_ANTENNA_GPIO_1 0
125 #define BW_ISDBT_1SEG 4
126 #define BW_ISDBT_3SEG 5
128 #define MSG_HDR_FLAG_SPLIT_MSG 4
130 #define MAX_GPIO_PIN_NUMBER 31
133 #define SMS_HOST_LIB 150
134 #define DVBT_BDA_CONTROL_MSG_ID 201
136 #define SMS_MAX_PAYLOAD_SIZE 240
137 #define SMS_TUNE_TIMEOUT 500
139 #define MSG_SMS_GPIO_CONFIG_REQ 507
140 #define MSG_SMS_GPIO_CONFIG_RES 508
141 #define MSG_SMS_GPIO_SET_LEVEL_REQ 509
142 #define MSG_SMS_GPIO_SET_LEVEL_RES 510
143 #define MSG_SMS_GPIO_GET_LEVEL_REQ 511
144 #define MSG_SMS_GPIO_GET_LEVEL_RES 512
145 #define MSG_SMS_RF_TUNE_REQ 561
146 #define MSG_SMS_RF_TUNE_RES 562
147 #define MSG_SMS_INIT_DEVICE_REQ 578
148 #define MSG_SMS_INIT_DEVICE_RES 579
149 #define MSG_SMS_ADD_PID_FILTER_REQ 601
150 #define MSG_SMS_ADD_PID_FILTER_RES 602
151 #define MSG_SMS_REMOVE_PID_FILTER_REQ 603
152 #define MSG_SMS_REMOVE_PID_FILTER_RES 604
153 #define MSG_SMS_DAB_CHANNEL 607
154 #define MSG_SMS_GET_PID_FILTER_LIST_REQ 608
155 #define MSG_SMS_GET_PID_FILTER_LIST_RES 609
156 #define MSG_SMS_GET_STATISTICS_REQ 615
157 #define MSG_SMS_GET_STATISTICS_RES 616
158 #define MSG_SMS_SET_ANTENNA_CONFIG_REQ 651
159 #define MSG_SMS_SET_ANTENNA_CONFIG_RES 652
160 #define MSG_SMS_GET_STATISTICS_EX_REQ 653
161 #define MSG_SMS_GET_STATISTICS_EX_RES 654
162 #define MSG_SMS_SLEEP_RESUME_COMP_IND 655
163 #define MSG_SMS_DATA_DOWNLOAD_REQ 660
164 #define MSG_SMS_DATA_DOWNLOAD_RES 661
165 #define MSG_SMS_SWDOWNLOAD_TRIGGER_REQ 664
166 #define MSG_SMS_SWDOWNLOAD_TRIGGER_RES 665
167 #define MSG_SMS_SWDOWNLOAD_BACKDOOR_REQ 666
168 #define MSG_SMS_SWDOWNLOAD_BACKDOOR_RES 667
169 #define MSG_SMS_GET_VERSION_EX_REQ 668
170 #define MSG_SMS_GET_VERSION_EX_RES 669
171 #define MSG_SMS_SET_CLOCK_OUTPUT_REQ 670
172 #define MSG_SMS_I2C_SET_FREQ_REQ 685
173 #define MSG_SMS_GENERIC_I2C_REQ 687
174 #define MSG_SMS_GENERIC_I2C_RES 688
175 #define MSG_SMS_DVBT_BDA_DATA 693
176 #define MSG_SW_RELOAD_REQ 697
177 #define MSG_SMS_DATA_MSG 699
178 #define MSG_SW_RELOAD_START_REQ 702
179 #define MSG_SW_RELOAD_START_RES 703
180 #define MSG_SW_RELOAD_EXEC_REQ 704
181 #define MSG_SW_RELOAD_EXEC_RES 705
182 #define MSG_SMS_SPI_INT_LINE_SET_REQ 710
183 #define MSG_SMS_ISDBT_TUNE_REQ 776
184 #define MSG_SMS_ISDBT_TUNE_RES 777
186 #define SMS_INIT_MSG_EX(ptr, type, src, dst, len) do { \
187 (ptr)->msgType = type; (ptr)->msgSrcId = src; (ptr)->msgDstId = dst; \
188 (ptr)->msgLength = len; (ptr)->msgFlags = 0; \
190 #define SMS_INIT_MSG(ptr, type, len) SMS_INIT_MSG_EX(ptr, type, 0, HIF_TASK, len)
194 DEVICE_MODE_NONE = -1,
195 DEVICE_MODE_DVBT = 0,
197 DEVICE_MODE_DAB_TDMB,
198 DEVICE_MODE_DAB_TDMB_DABIP,
199 DEVICE_MODE_DVBT_BDA,
201 DEVICE_MODE_ISDBT_BDA,
203 DEVICE_MODE_RAW_TUNER,
207 typedef unsigned char UINT8;
208 typedef unsigned short UINT16;
209 typedef unsigned int UINT32;
212 typedef struct SmsMsgHdr_S
217 UINT16 msgLength; // Length is of the entire message, including header
221 typedef struct SmsMsgData_S
223 SmsMsgHdr_ST xMsgHeader;
227 typedef struct SmsDataDownload_S
229 SmsMsgHdr_ST xMsgHeader;
231 UINT8 Payload[SMS_MAX_PAYLOAD_SIZE];
232 } SmsDataDownload_ST;
234 typedef struct SmsVersionRes_S
236 SmsMsgHdr_ST xMsgHeader;
238 UINT16 ChipModel; // e.g. 0x1102 for SMS-1102 "Nova"
239 UINT8 Step; // 0 - Step A
240 UINT8 MetalFix; // 0 - Metal 0
242 UINT8 FirmwareId; // 0xFF � ROM, otherwise the value indicated by SMSHOSTLIB_DEVICE_MODES_E
243 UINT8 SupportedProtocols; // Bitwise OR combination of supported protocols
248 UINT8 VersionFieldPatch;
250 UINT8 RomVersionMajor;
251 UINT8 RomVersionMinor;
252 UINT8 RomVersionPatch;
253 UINT8 RomVersionFieldPatch;
258 typedef struct SmsFirmware_S
266 typedef struct SMSHOSTLIB_STATISTICS_S
268 UINT32 Reserved; //!< Reserved
270 /// Common parameters
271 UINT32 IsRfLocked; //!< 0 - not locked, 1 - locked
272 UINT32 IsDemodLocked; //!< 0 - not locked, 1 - locked
273 UINT32 IsExternalLNAOn; //!< 0 - external LNA off, 1 - external LNA on
275 /// Reception quality
277 UINT32 BER; //!< Post Viterbi BER [1E-5]
278 UINT32 FIB_CRC; //!< CRC errors percentage, valid only for DAB
279 UINT32 TS_PER; //!< Transport stream PER, 0xFFFFFFFF indicate N/A, valid only for DVB-T/H
280 UINT32 MFER; //!< DVB-H frame error rate in percentage, 0xFFFFFFFF indicate N/A, valid only for DVB-H
282 INT32 InBandPwr; //!< In band power in dBM
283 INT32 CarrierOffset; //!< Carrier Offset in bin/1024
285 /// Transmission parameters
286 UINT32 Frequency; //!< Frequency in Hz
287 UINT32 Bandwidth; //!< Bandwidth in MHz, valid only for DVB-T/H
288 UINT32 TransmissionMode; //!< Transmission Mode, for DAB modes 1-4, for DVB-T/H FFT mode carriers in Kilos
289 UINT32 ModemState; //!< from SMS_DvbModemState_ET , valid only for DVB-T/H
290 UINT32 GuardInterval; //!< Guard Interval, 1 divided by value , valid only for DVB-T/H
291 UINT32 CodeRate; //!< Code Rate from SMS_DvbModemState_ET, valid only for DVB-T/H
292 UINT32 LPCodeRate; //!< Low Priority Code Rate from SMS_DvbModemState_ET, valid only for DVB-T/H
293 UINT32 Hierarchy; //!< Hierarchy from SMS_Hierarchy_ET, valid only for DVB-T/H
294 UINT32 Constellation; //!< Constellation from SMS_Constellation_ET, valid only for DVB-T/H
296 /// Burst parameters, valid only for DVB-H
297 UINT32 BurstSize; //!< Current burst size in bytes, valid only for DVB-H
298 UINT32 BurstDuration; //!< Current burst duration in mSec, valid only for DVB-H
299 UINT32 BurstCycleTime; //!< Current burst cycle time in mSec, valid only for DVB-H
300 UINT32 CalculatedBurstCycleTime;//!< Current burst cycle time in mSec, as calculated by demodulator, valid only for DVB-H
301 UINT32 NumOfRows; //!< Number of rows in MPE table, valid only for DVB-H
302 UINT32 NumOfPaddCols; //!< Number of padding columns in MPE table, valid only for DVB-H
303 UINT32 NumOfPunctCols; //!< Number of puncturing columns in MPE table, valid only for DVB-H
304 UINT32 ErrorTSPackets; //!< Number of erroneous transport-stream packets
305 UINT32 TotalTSPackets; //!< Total number of transport-stream packets
306 UINT32 NumOfValidMpeTlbs; //!< Number of MPE tables which do not include errors after MPE RS decoding
307 UINT32 NumOfInvalidMpeTlbs; //!< Number of MPE tables which include errors after MPE RS decoding
308 UINT32 NumOfCorrectedMpeTlbs; //!< Number of MPE tables which were corrected by MPE RS decoding
310 UINT32 BERErrorCount; //!< Number of errornous SYNC bits.
311 UINT32 BERBitCount; //!< Total number of SYNC bits.
313 /// Interface information
314 UINT32 SmsToHostTxErrors; //!< Total number of transmission errors.
317 UINT32 PreBER; //!< DAB/T-DMB only: Pre Viterbi BER [1E-5]
319 /// DVB-H TPS parameters
320 UINT32 CellId; //!< TPS Cell ID in bits 15..0, bits 31..16 zero; if set to 0xFFFFFFFF cell_id not yet recovered
322 } SMSHOSTLIB_STATISTICS_ST;
326 UINT32 RequestResult;
328 SMSHOSTLIB_STATISTICS_ST Stat;
330 // Split the calc of the SNR in DAB
331 UINT32 Signal; //!< dB
332 UINT32 Noise; //!< dB
334 } SmsMsgStatisticsInfo_ST;
336 typedef struct SMSHOSTLIB_ISDBT_LAYER_STAT_S
338 // Per-layer information
339 UINT32 CodeRate; //!< Code Rate from SMSHOSTLIB_CODE_RATE_ET, 255 means layer does not exist
340 UINT32 Constellation; //!< Constellation from SMSHOSTLIB_CONSTELLATION_ET, 255 means layer does not exist
341 UINT32 BER; //!< Post Viterbi BER [1E-5], 0xFFFFFFFF indicate N/A
342 UINT32 BERErrorCount; //!< Post Viterbi Error Bits Count
343 UINT32 BERBitCount; //!< Post Viterbi Total Bits Count
344 UINT32 PreBER; //!< Pre Viterbi BER [1E-5], 0xFFFFFFFF indicate N/A
345 UINT32 TS_PER; //!< Transport stream PER [%], 0xFFFFFFFF indicate N/A
346 UINT32 ErrorTSPackets; //!< Number of erroneous transport-stream packets
347 UINT32 TotalTSPackets; //!< Total number of transport-stream packets
348 UINT32 TILdepthI; //!< Time interleaver depth I parameter, 255 means layer does not exist
349 UINT32 NumberOfSegments; //!< Number of segments in layer A, 255 means layer does not exist
350 UINT32 TMCCErrors; //!< TMCC errors
351 } SMSHOSTLIB_ISDBT_LAYER_STAT_ST;
353 typedef struct SMSHOSTLIB_STATISTICS_ISDBT_S
355 UINT32 StatisticsType; //!< Enumerator identifying the type of the structure. Values are the same as SMSHOSTLIB_DEVICE_MODES_E
356 //!< This fiels MUST always first in any statistics structure
358 UINT32 FullSize; //!< Total size of the structure returned by the modem. If the size requested by
359 //!< the host is smaller than FullSize, the struct will be truncated
362 UINT32 IsRfLocked; //!< 0 - not locked, 1 - locked
363 UINT32 IsDemodLocked; //!< 0 - not locked, 1 - locked
364 UINT32 IsExternalLNAOn; //!< 0 - external LNA off, 1 - external LNA on
369 INT32 InBandPwr; //!< In band power in dBM
370 INT32 CarrierOffset; //!< Carrier Offset in Hz
372 // Transmission parameters
373 UINT32 Frequency; //!< Frequency in Hz
374 UINT32 Bandwidth; //!< Bandwidth in MHz
375 UINT32 TransmissionMode; //!< ISDB-T transmission mode
376 UINT32 ModemState; //!< 0 - Acquisition, 1 - Locked
377 UINT32 GuardInterval; //!< Guard Interval, 1 divided by value
378 UINT32 SystemType; //!< ISDB-T system type (ISDB-T / ISDB-Tsb)
379 UINT32 PartialReception; //!< TRUE - partial reception, FALSE otherwise
380 UINT32 NumOfLayers; //!< Number of ISDB-T layers in the network
382 // Per-layer information
384 SMSHOSTLIB_ISDBT_LAYER_STAT_ST LayerInfo[3]; //!< Per-layer statistics, see SMSHOSTLIB_ISDBT_LAYER_STAT_ST
386 // Interface information
387 UINT32 SmsToHostTxErrors; //!< Total number of transmission errors.
389 } SMSHOSTLIB_STATISTICS_ISDBT_ST;
391 typedef struct SMSHOSTLIB_STATISTICS_DVB_S
393 UINT32 StatisticsType; //!< Enumerator identifying the type of the structure. Values are the same as SMSHOSTLIB_DEVICE_MODES_E
394 //!< This fiels MUST always first in any statistics structure
396 UINT32 FullSize; //!< Total size of the structure returned by the modem. If the size requested by
397 //!< the host is smaller than FullSize, the struct will be truncated
399 UINT32 IsRfLocked; //!< 0 - not locked, 1 - locked
400 UINT32 IsDemodLocked; //!< 0 - not locked, 1 - locked
401 UINT32 IsExternalLNAOn; //!< 0 - external LNA off, 1 - external LNA on
405 UINT32 BER; //!< Post Viterbi BER [1E-5]
406 UINT32 BERErrorCount; //!< Number of errornous SYNC bits.
407 UINT32 BERBitCount; //!< Total number of SYNC bits.
408 UINT32 TS_PER; //!< Transport stream PER, 0xFFFFFFFF indicate N/A
409 UINT32 MFER; //!< DVB-H frame error rate in percentage, 0xFFFFFFFF indicate N/A, valid only for DVB-H
411 INT32 InBandPwr; //!< In band power in dBM
412 INT32 CarrierOffset; //!< Carrier Offset in bin/1024
414 // Transmission parameters
415 UINT32 Frequency; //!< Frequency in Hz
416 UINT32 Bandwidth; //!< Bandwidth in MHz
417 UINT32 ModemState; //!< from SMSHOSTLIB_DVB_MODEM_STATE_ET
418 UINT32 TransmissionMode; //!< FFT mode carriers in Kilos
419 UINT32 GuardInterval; //!< Guard Interval, 1 divided by value
420 UINT32 CodeRate; //!< Code Rate from SMSHOSTLIB_CODE_RATE_ET
421 UINT32 LPCodeRate; //!< Low Priority Code Rate from SMSHOSTLIB_CODE_RATE_ET
422 UINT32 Hierarchy; //!< Hierarchy from SMSHOSTLIB_HIERARCHY_ET
423 UINT32 Constellation; //!< Constellation from SMSHOSTLIB_CONSTELLATION_ET
425 // Burst parameters, valid only for DVB-H
426 UINT32 BurstSize; //!< Current burst size in bytes, valid only for DVB-H
427 UINT32 BurstDuration; //!< Current burst duration in mSec, valid only for DVB-H
428 UINT32 BurstCycleTime; //!< Current burst cycle time in mSec, valid only for DVB-H
429 UINT32 CalculatedBurstCycleTime;//!< Current burst cycle time in mSec, as calculated by demodulator, valid only for DVB-H
430 UINT32 NumOfRows; //!< Number of rows in MPE table, valid only for DVB-H
431 UINT32 NumOfPaddCols; //!< Number of padding columns in MPE table, valid only for DVB-H
432 UINT32 NumOfPunctCols; //!< Number of puncturing columns in MPE table, valid only for DVB-H
433 UINT32 ErrorTSPackets; //!< Number of erroneous transport-stream packets
434 UINT32 TotalTSPackets; //!< Total number of transport-stream packets
435 UINT32 NumOfValidMpeTlbs; //!< Number of MPE tables which do not include errors after MPE RS decoding, valid only for DVB-H
436 UINT32 NumOfInvalidMpeTlbs; //!< Number of MPE tables which include errors after MPE RS decoding, valid only for DVB-H
437 UINT32 NumOfCorrectedMpeTlbs; //!< Number of MPE tables which were corrected by MPE RS decoding, valid only for DVB-H
438 UINT32 NumMPEReceived; //!< DVB-H, Num MPE section received
440 // DVB-H TPS parameters
441 UINT32 CellId; //!< TPS Cell ID in bits 15..0, bits 31..16 zero; if set to 0xFFFFFFFF cell_id not yet recovered
442 UINT32 DvbhSrvIndHP; //!< DVB-H service indication info, bit 1 - Time Slicing indicator, bit 0 - MPE-FEC indicator
443 UINT32 DvbhSrvIndLP; //!< DVB-H service indication info, bit 1 - Time Slicing indicator, bit 0 - MPE-FEC indicator
445 // Interface information
446 UINT32 SmsToHostTxErrors; //!< Total number of transmission errors.
448 } SMSHOSTLIB_STATISTICS_DVB_ST;
450 typedef struct SMSHOSTLIB_GPIO_CONFIG_S
452 UINT8 Direction; //!< GPIO direction: Input - 0, Output - 1
453 UINT8 PullUpDown; //!< PullUp/PullDown: None - 0, PullDown - 1, PullUp - 2, Keeper - 3
454 UINT8 InputCharacteristics; //!< Input Characteristics: Normal - 0, Schmitt trigger - 1
455 UINT8 OutputSlewRate; //!< Output Slew Rate: Fast slew rate - 0, Slow slew rate - 1
456 UINT8 OutputDriving; //!< Output driving capability: 4mA - 0, 8mA - 1, 12mA - 2, 16mA - 3
457 } SMSHOSTLIB_GPIO_CONFIG_ST;
459 typedef struct SMSHOSTLIB_I2C_REQ_S
461 UINT32 DeviceAddress; // I2c device address
462 UINT32 WriteCount; // number of bytes to write
463 UINT32 ReadCount; // number of bytes to read
465 } SMSHOSTLIB_I2C_REQ_ST;
467 typedef struct SMSHOSTLIB_I2C_RES_S
469 UINT32 Status; // non-zero value in case of failure
470 UINT32 ReadCount; // number of bytes read
472 } SMSHOSTLIB_I2C_RES_ST;
474 typedef struct _smsdvb_client
476 struct list_head entry;
478 smscore_device_t *coredev;
479 smscore_client_t *smsclient;
481 struct dvb_adapter adapter;
482 struct dvb_demux demux;
483 struct dmxdev dmxdev;
484 struct dvb_frontend frontend;
486 fe_status_t fe_status;
487 int fe_ber, fe_snr, fe_signal_strength;
489 struct completion tune_done, stat_done;
491 // todo: save freq/band instead whole struct
492 struct dvb_frontend_parameters fe_params;
496 extern void smscore_registry_setmode(char *devpath, int mode);
497 extern int smscore_registry_getmode(char *devpath);
499 extern int smscore_register_hotplug(hotplug_t hotplug);
500 extern void smscore_unregister_hotplug(hotplug_t hotplug);
502 extern int smscore_register_device(smsdevice_params_t *params, smscore_device_t **coredev);
503 extern void smscore_unregister_device(smscore_device_t *coredev);
505 extern int smscore_start_device(smscore_device_t *coredev);
506 extern int smscore_load_firmware(smscore_device_t *coredev, char* filename, loadfirmware_t loadfirmware_handler);
508 extern int smscore_set_device_mode(smscore_device_t *coredev, int mode);
509 extern int smscore_get_device_mode(smscore_device_t *coredev);
511 extern int smscore_register_client(smscore_device_t *coredev, smsclient_params_t* params, smscore_client_t **client);
512 extern void smscore_unregister_client(smscore_client_t *client);
514 extern int smsclient_sendrequest(smscore_client_t *client, void *buffer, size_t size);
515 extern void smscore_onresponse(smscore_device_t *coredev, smscore_buffer_t *cb);
517 extern int smscore_get_common_buffer_size(smscore_device_t *coredev);
518 extern int smscore_map_common_buffer(smscore_device_t *coredev, struct vm_area_struct * vma);
520 extern smscore_buffer_t *smscore_getbuffer(smscore_device_t *coredev);
521 extern void smscore_putbuffer(smscore_device_t *coredev, smscore_buffer_t *cb);
524 int smsdvb_register(void);
525 void smsdvb_unregister(void);
528 int smsusb_register(void);
529 void smsusb_unregister(void);
531 #endif // __smscoreapi_h__