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_)
47 #define min(a, b) (((a) < (b)) ? (a) : (b))
50 #define SMS_ALLOC_ALIGNMENT 128
51 #define SMS_DMA_ALIGNMENT 16
52 #define SMS_ALIGN_ADDRESS(addr) \
53 ((((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 enum sms_device_type_st {
64 SMS_NUM_OF_DEVICE_TYPES
67 struct smscore_device_t;
68 struct smscore_client_t;
69 struct smscore_buffer_t;
71 typedef int (*hotplug_t)(struct smscore_device_t *coredev,
72 struct device *device, int arrival);
74 typedef int (*setmode_t)(void *context, int mode);
75 typedef void (*detectmode_t)(void *context, int *mode);
76 typedef int (*sendrequest_t)(void *context, void *buffer, size_t size);
77 typedef int (*loadfirmware_t)(void *context, void *buffer, size_t size);
78 typedef int (*preload_t)(void *context);
79 typedef int (*postload_t)(void *context);
81 typedef int (*onresponse_t)(void *context, struct smscore_buffer_t *cb);
82 typedef void (*onremove_t)(void *context);
84 struct smscore_buffer_t {
85 /* public members, once passed to clients can be changed freely */
86 struct list_head entry;
90 /* private members, read-only for clients */
93 unsigned long offset_in_common;
96 struct smsdevice_params_t {
97 struct device *device;
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;
112 enum sms_device_type_st device_type;
115 struct smsclient_params_t {
118 onresponse_t onresponse_handler;
119 onremove_t onremove_handler;
124 /* GPIO definitions for antenna frequency domain control (SMS8021) */
125 #define SMS_ANTENNA_GPIO_0 1
126 #define SMS_ANTENNA_GPIO_1 0
132 #define BW_ISDBT_1SEG 4
133 #define BW_ISDBT_3SEG 5
135 #define MSG_HDR_FLAG_SPLIT_MSG 4
137 #define MAX_GPIO_PIN_NUMBER 31
140 #define SMS_HOST_LIB 150
141 #define DVBT_BDA_CONTROL_MSG_ID 201
143 #define SMS_MAX_PAYLOAD_SIZE 240
144 #define SMS_TUNE_TIMEOUT 500
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
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; \
197 #define SMS_INIT_MSG(ptr, type, len) \
198 SMS_INIT_MSG_EX(ptr, type, 0, HIF_TASK, len)
200 enum SMS_DEVICE_MODE {
201 DEVICE_MODE_NONE = -1,
202 DEVICE_MODE_DVBT = 0,
204 DEVICE_MODE_DAB_TDMB,
205 DEVICE_MODE_DAB_TDMB_DABIP,
206 DEVICE_MODE_DVBT_BDA,
208 DEVICE_MODE_ISDBT_BDA,
210 DEVICE_MODE_RAW_TUNER,
214 struct SmsMsgHdr_ST {
218 u16 msgLength; /* Length of entire message, including header */
222 struct SmsMsgData_ST {
223 struct SmsMsgHdr_ST xMsgHeader;
227 struct SmsDataDownload_ST {
228 struct SmsMsgHdr_ST xMsgHeader;
230 u8 Payload[SMS_MAX_PAYLOAD_SIZE];
233 struct SmsVersionRes_ST {
234 struct SmsMsgHdr_ST xMsgHeader;
236 u16 ChipModel; /* e.g. 0x1102 for SMS-1102 "Nova" */
237 u8 Step; /* 0 - Step A */
238 u8 MetalFix; /* 0 - Metal 0 */
240 u8 FirmwareId; /* 0xFF � ROM, otherwise the
242 * SMSHOSTLIB_DEVICE_MODES_E */
243 u8 SupportedProtocols; /* Bitwise OR combination of
244 * supported protocols */
249 u8 VersionFieldPatch;
254 u8 RomVersionFieldPatch;
259 struct SmsFirmware_ST {
266 struct SMSHOSTLIB_STATISTICS_ST {
267 u32 Reserved; /* Reserved */
269 /* Common parameters */
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 */
274 /* Reception quality */
276 u32 BER; /* Post Viterbi BER [1E-5] */
277 u32 FIB_CRC; /* CRC errors percentage, valid only for DAB */
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 */
283 s32 InBandPwr; /* In band power in dBM */
284 s32 CarrierOffset; /* Carrier Offset in bin/1024 */
286 /* Transmission parameters, valid only for DVB-T/H */
287 u32 Frequency; /* Frequency in Hz */
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 */
298 /* Burst parameters, valid only for DVB-H */
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 */
308 u32 ErrorTSPackets; /* Number of erroneous transport-stream packets */
309 u32 TotalTSPackets; /* Total number of transport-stream packets */
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 */
318 u32 BERErrorCount; /* Number of errornous SYNC bits. */
319 u32 BERBitCount; /* Total number of SYNC bits. */
321 /* Interface information */
322 u32 SmsToHostTxErrors; /* Total number of transmission errors. */
325 u32 PreBER; /* DAB/T-DMB only: Pre Viterbi BER [1E-5] */
327 /* DVB-H TPS parameters */
328 u32 CellId; /* TPS Cell ID in bits 15..0, bits 31..16 zero;
329 * if set to 0xFFFFFFFF cell_id not yet recovered */
333 struct SmsMsgStatisticsInfo_ST {
336 struct SMSHOSTLIB_STATISTICS_ST Stat;
338 /* Split the calc of the SNR in DAB */
345 struct smsdvb_client_t {
346 struct list_head entry;
348 struct smscore_device_t *coredev;
349 struct smscore_client_t *smsclient;
351 struct dvb_adapter adapter;
352 struct dvb_demux demux;
353 struct dmxdev dmxdev;
354 struct dvb_frontend frontend;
356 fe_status_t fe_status;
357 int fe_ber, fe_snr, fe_signal_strength;
359 struct completion tune_done, stat_done;
361 /* todo: save freq/band instead whole struct */
362 struct dvb_frontend_parameters fe_params;
366 extern void smscore_registry_setmode(char *devpath, int mode);
367 extern int smscore_registry_getmode(char *devpath);
369 extern int smscore_register_hotplug(hotplug_t hotplug);
370 extern void smscore_unregister_hotplug(hotplug_t hotplug);
372 extern int smscore_register_device(struct smsdevice_params_t *params,
373 struct smscore_device_t **coredev);
374 extern void smscore_unregister_device(struct smscore_device_t *coredev);
376 extern int smscore_start_device(struct smscore_device_t *coredev);
377 extern int smscore_load_firmware(struct smscore_device_t *coredev,
379 loadfirmware_t loadfirmware_handler);
381 extern int smscore_load_firmware_from_buffer(struct smscore_device_t *coredev,
382 u8 *buffer, int size,
385 extern int smscore_set_device_mode(struct smscore_device_t *coredev, int mode);
386 extern int smscore_get_device_mode(struct smscore_device_t *coredev);
388 extern int smscore_register_client(struct smscore_device_t *coredev,
389 struct smsclient_params_t *params,
390 struct smscore_client_t **client);
391 extern void smscore_unregister_client(struct smscore_client_t *client);
393 extern int smsclient_sendrequest(struct smscore_client_t *client,
394 void *buffer, size_t size);
395 extern void smscore_onresponse(struct smscore_device_t *coredev,
396 struct smscore_buffer_t *cb);
398 extern int smscore_get_common_buffer_size(struct smscore_device_t *coredev);
399 extern int smscore_map_common_buffer(struct smscore_device_t *coredev,
400 struct vm_area_struct *vma);
402 extern struct smscore_buffer_t *smscore_getbuffer(struct smscore_device_t *coredev);
403 extern void smscore_putbuffer(struct smscore_device_t *coredev,
404 struct smscore_buffer_t *cb);
407 int smsdvb_register(void);
408 void smsdvb_unregister(void);
411 int smsusb_register(void);
412 void smsusb_unregister(void);
414 #endif /* __smscoreapi_h__ */