drivers:misc: ti-st: register with channel IDs
[linux-2.6.git] / include / linux / ti_wilink_st.h
1 /*
2  *  Shared Transport Header file
3  *      To be included by the protocol stack drivers for
4  *      Texas Instruments BT,FM and GPS combo chip drivers
5  *      and also serves the sub-modules of the shared transport driver.
6  *
7  *  Copyright (C) 2009-2010 Texas Instruments
8  *  Author: Pavan Savoy <pavan_savoy@ti.com>
9  *
10  *  This program is free software; you can redistribute it and/or modify
11  *  it under the terms of the GNU General Public License version 2 as
12  *  published by the Free Software Foundation.
13  *
14  *  This program is distributed in the hope that it will be useful,
15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *  GNU General Public License for more details.
18  *
19  *  You should have received a copy of the GNU General Public License
20  *  along with this program; if not, write to the Free Software
21  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22  *
23  */
24
25 #ifndef TI_WILINK_ST_H
26 #define TI_WILINK_ST_H
27
28 /**
29  * enum kim_gpio_state - Few protocols such as FM have ACTIVE LOW
30  *      gpio states for their chip/core enable gpios
31  */
32 enum kim_gpio_state {
33         KIM_GPIO_INACTIVE,
34         KIM_GPIO_ACTIVE,
35 };
36
37 /**
38  * enum proto-type - The protocol on WiLink chips which share a
39  *      common physical interface like UART.
40  */
41 enum proto_type {
42         ST_BT,
43         ST_FM,
44         ST_GPS,
45         ST_MAX_CHANNELS = 16,
46 };
47
48 /**
49  * struct st_proto_s - Per Protocol structure from BT/FM/GPS to ST
50  * @type: type of the protocol being registered among the
51  *      available proto_type(BT, FM, GPS the protocol which share TTY).
52  * @recv: the receiver callback pointing to a function in the
53  *      protocol drivers called by the ST driver upon receiving
54  *      relevant data.
55  * @match_packet: reserved for future use, to make ST more generic
56  * @reg_complete_cb: callback handler pointing to a function in protocol
57  *      handler called by ST when the pending registrations are complete.
58  *      The registrations are marked pending, in situations when fw
59  *      download is in progress.
60  * @write: pointer to function in ST provided to protocol drivers from ST,
61  *      to be made use when protocol drivers have data to send to TTY.
62  * @priv_data: privdate data holder for the protocol drivers, sent
63  *      from the protocol drivers during registration, and sent back on
64  *      reg_complete_cb and recv.
65  * @chnl_id: channel id the protocol driver is interested in, the channel
66  *      id is nothing but the 1st byte of the packet in UART frame.
67  * @max_frame_size: size of the largest frame the protocol can receive.
68  * @hdr_len: length of the header structure of the protocol.
69  * @offset_len_in_hdr: this provides the offset of the length field in the
70  *      header structure of the protocol header, to assist ST to know
71  *      how much to receive, if the data is split across UART frames.
72  * @len_size: whether the length field inside the header is 2 bytes
73  *      or 1 byte.
74  * @reserve: the number of bytes ST needs to reserve in the skb being
75  *      prepared for the protocol driver.
76  */
77 struct st_proto_s {
78         enum proto_type type;
79         long (*recv) (void *, struct sk_buff *);
80         unsigned char (*match_packet) (const unsigned char *data);
81         void (*reg_complete_cb) (void *, char data);
82         long (*write) (struct sk_buff *skb);
83         void *priv_data;
84
85         unsigned char chnl_id;
86         unsigned short max_frame_size;
87         unsigned char hdr_len;
88         unsigned char offset_len_in_hdr;
89         unsigned char len_size;
90         unsigned char reserve;
91 };
92
93 extern long st_register(struct st_proto_s *);
94 extern long st_unregister(struct st_proto_s *);
95
96
97 /*
98  * header information used by st_core.c
99  */
100
101 /* states of protocol list */
102 #define ST_NOTEMPTY     1
103 #define ST_EMPTY        0
104
105 /*
106  * possible st_states
107  */
108 #define ST_INITIALIZING         1
109 #define ST_REG_IN_PROGRESS      2
110 #define ST_REG_PENDING          3
111 #define ST_WAITING_FOR_RESP     4
112
113 /**
114  * struct st_data_s - ST core internal structure
115  * @st_state: different states of ST like initializing, registration
116  *      in progress, this is mainly used to return relevant err codes
117  *      when protocol drivers are registering. It is also used to track
118  *      the recv function, as in during fw download only HCI events
119  *      can occur , where as during other times other events CH8, CH9
120  *      can occur.
121  * @tty: tty provided by the TTY core for line disciplines.
122  * @tx_skb: If for some reason the tty's write returns lesser bytes written
123  *      then to maintain the rest of data to be written on next instance.
124  *      This needs to be protected, hence the lock inside wakeup func.
125  * @tx_state: if the data is being written onto the TTY and protocol driver
126  *      wants to send more, queue up data and mark that there is
127  *      more data to send.
128  * @list: the list of protocols registered, only MAX can exist, one protocol
129  *      can register only once.
130  * @rx_state: states to be maintained inside st's tty receive
131  * @rx_count: count to be maintained inside st's tty receieve
132  * @rx_skb: the skb where all data for a protocol gets accumulated,
133  *      since tty might not call receive when a complete event packet
134  *      is received, the states, count and the skb needs to be maintained.
135  * @rx_chnl: the channel ID for which the data is getting accumalated for.
136  * @txq: the list of skbs which needs to be sent onto the TTY.
137  * @tx_waitq: if the chip is not in AWAKE state, the skbs needs to be queued
138  *      up in here, PM(WAKEUP_IND) data needs to be sent and then the skbs
139  *      from waitq can be moved onto the txq.
140  *      Needs locking too.
141  * @lock: the lock to protect skbs, queues, and ST states.
142  * @protos_registered: count of the protocols registered, also when 0 the
143  *      chip enable gpio can be toggled, and when it changes to 1 the fw
144  *      needs to be downloaded to initialize chip side ST.
145  * @ll_state: the various PM states the chip can be, the states are notified
146  *      to us, when the chip sends relevant PM packets(SLEEP_IND, WAKE_IND).
147  * @kim_data: reference to the parent encapsulating structure.
148  *
149  */
150 struct st_data_s {
151         unsigned long st_state;
152         struct tty_struct *tty;
153         struct sk_buff *tx_skb;
154 #define ST_TX_SENDING   1
155 #define ST_TX_WAKEUP    2
156         unsigned long tx_state;
157         struct st_proto_s *list[ST_MAX_CHANNELS];
158         unsigned long rx_state;
159         unsigned long rx_count;
160         struct sk_buff *rx_skb;
161         unsigned char rx_chnl;
162         struct sk_buff_head txq, tx_waitq;
163         spinlock_t lock;
164         unsigned char   protos_registered;
165         unsigned long ll_state;
166         void *kim_data;
167 };
168
169 /**
170  * st_int_write -
171  * point this to tty->driver->write or tty->ops->write
172  * depending upon the kernel version
173  */
174 int st_int_write(struct st_data_s*, const unsigned char*, int);
175
176 /**
177  * st_write -
178  * internal write function, passed onto protocol drivers
179  * via the write function ptr of protocol struct
180  */
181 long st_write(struct sk_buff *);
182
183 /* function to be called from ST-LL */
184 void st_ll_send_frame(enum proto_type, struct sk_buff *);
185
186 /* internal wake up function */
187 void st_tx_wakeup(struct st_data_s *st_data);
188
189 /* init, exit entry funcs called from KIM */
190 int st_core_init(struct st_data_s **);
191 void st_core_exit(struct st_data_s *);
192
193 /* ask for reference from KIM */
194 void st_kim_ref(struct st_data_s **, int);
195
196 #define GPS_STUB_TEST
197 #ifdef GPS_STUB_TEST
198 int gps_chrdrv_stub_write(const unsigned char*, int);
199 void gps_chrdrv_stub_init(void);
200 #endif
201
202 /*
203  * header information used by st_kim.c
204  */
205
206 /* time in msec to wait for
207  * line discipline to be installed
208  */
209 #define LDISC_TIME      500
210 #define CMD_RESP_TIME   500
211 #define MAKEWORD(a, b)  ((unsigned short)(((unsigned char)(a)) \
212         | ((unsigned short)((unsigned char)(b))) << 8))
213
214 #define GPIO_HIGH 1
215 #define GPIO_LOW  0
216
217 /* the Power-On-Reset logic, requires to attempt
218  * to download firmware onto chip more than once
219  * since the self-test for chip takes a while
220  */
221 #define POR_RETRY_COUNT 5
222
223 /**
224  * struct chip_version - save the chip version
225  */
226 struct chip_version {
227         unsigned short full;
228         unsigned short chip;
229         unsigned short min_ver;
230         unsigned short maj_ver;
231 };
232
233 /**
234  * struct kim_data_s - the KIM internal data, embedded as the
235  *      platform's drv data. One for each ST device in the system.
236  * @uim_pid: KIM needs to communicate with UIM to request to install
237  *      the ldisc by opening UART when protocol drivers register.
238  * @kim_pdev: the platform device added in one of the board-XX.c file
239  *      in arch/XX/ directory, 1 for each ST device.
240  * @kim_rcvd: completion handler to notify when data was received,
241  *      mainly used during fw download, which involves multiple send/wait
242  *      for each of the HCI-VS commands.
243  * @ldisc_installed: completion handler to notify that the UIM accepted
244  *      the request to install ldisc, notify from tty_open which suggests
245  *      the ldisc was properly installed.
246  * @resp_buffer: data buffer for the .bts fw file name.
247  * @fw_entry: firmware class struct to request/release the fw.
248  * @gpios: the list of core/chip enable gpios for BT, FM and GPS cores.
249  * @rx_state: the rx state for kim's receive func during fw download.
250  * @rx_count: the rx count for the kim's receive func during fw download.
251  * @rx_skb: all of fw data might not come at once, and hence data storage for
252  *      whole of the fw response, only HCI_EVENTs and hence diff from ST's
253  *      response.
254  * @rfkill: rfkill data for each of the cores to be registered with rfkill.
255  * @rf_protos: proto types of the data registered with rfkill sub-system.
256  * @core_data: ST core's data, which mainly is the tty's disc_data
257  * @version: chip version available via a sysfs entry.
258  *
259  */
260 struct kim_data_s {
261         long uim_pid;
262         struct platform_device *kim_pdev;
263         struct completion kim_rcvd, ldisc_installed;
264         char resp_buffer[30];
265         const struct firmware *fw_entry;
266         long gpios[ST_MAX_CHANNELS];
267         unsigned long rx_state;
268         unsigned long rx_count;
269         struct sk_buff *rx_skb;
270         struct rfkill *rfkill[ST_MAX_CHANNELS];
271         enum proto_type rf_protos[ST_MAX_CHANNELS];
272         struct st_data_s *core_data;
273         struct chip_version version;
274 };
275
276 /**
277  * functions called when 1 of the protocol drivers gets
278  * registered, these need to communicate with UIM to request
279  * ldisc installed, read chip_version, download relevant fw
280  */
281 long st_kim_start(void *);
282 long st_kim_stop(void *);
283
284 void st_kim_recv(void *, const unsigned char *, long count);
285 void st_kim_chip_toggle(enum proto_type, enum kim_gpio_state);
286 void st_kim_complete(void *);
287 void kim_st_list_protocols(struct st_data_s *, void *);
288
289 /*
290  * BTS headers
291  */
292 #define ACTION_SEND_COMMAND     1
293 #define ACTION_WAIT_EVENT       2
294 #define ACTION_SERIAL           3
295 #define ACTION_DELAY            4
296 #define ACTION_RUN_SCRIPT       5
297 #define ACTION_REMARKS          6
298
299 /**
300  * struct bts_header - the fw file is NOT binary which can
301  *      be sent onto TTY as is. The .bts is more a script
302  *      file which has different types of actions.
303  *      Each such action needs to be parsed by the KIM and
304  *      relevant procedure to be called.
305  */
306 struct bts_header {
307         u32 magic;
308         u32 version;
309         u8 future[24];
310         u8 actions[0];
311 } __attribute__ ((packed));
312
313 /**
314  * struct bts_action - Each .bts action has its own type of
315  *      data.
316  */
317 struct bts_action {
318         u16 type;
319         u16 size;
320         u8 data[0];
321 } __attribute__ ((packed));
322
323 struct bts_action_send {
324         u8 data[0];
325 } __attribute__ ((packed));
326
327 struct bts_action_wait {
328         u32 msec;
329         u32 size;
330         u8 data[0];
331 } __attribute__ ((packed));
332
333 struct bts_action_delay {
334         u32 msec;
335 } __attribute__ ((packed));
336
337 struct bts_action_serial {
338         u32 baud;
339         u32 flow_control;
340 } __attribute__ ((packed));
341
342 /**
343  * struct hci_command - the HCI-VS for intrepreting
344  *      the change baud rate of host-side UART, which
345  *      needs to be ignored, since UIM would do that
346  *      when it receives request from KIM for ldisc installation.
347  */
348 struct hci_command {
349         u8 prefix;
350         u16 opcode;
351         u8 plen;
352         u32 speed;
353 } __attribute__ ((packed));
354
355 /*
356  * header information used by st_ll.c
357  */
358
359 /* ST LL receiver states */
360 #define ST_W4_PACKET_TYPE       0
361 #define ST_W4_HEADER            1
362 #define ST_W4_DATA              2
363
364 /* ST LL state machines */
365 #define ST_LL_ASLEEP               0
366 #define ST_LL_ASLEEP_TO_AWAKE      1
367 #define ST_LL_AWAKE                2
368 #define ST_LL_AWAKE_TO_ASLEEP      3
369 #define ST_LL_INVALID              4
370
371 /* different PM notifications coming from chip */
372 #define LL_SLEEP_IND    0x30
373 #define LL_SLEEP_ACK    0x31
374 #define LL_WAKE_UP_IND  0x32
375 #define LL_WAKE_UP_ACK  0x33
376
377 /* initialize and de-init ST LL */
378 long st_ll_init(struct st_data_s *);
379 long st_ll_deinit(struct st_data_s *);
380
381 /**
382  * enable/disable ST LL along with KIM start/stop
383  * called by ST Core
384  */
385 void st_ll_enable(struct st_data_s *);
386 void st_ll_disable(struct st_data_s *);
387
388 /**
389  * various funcs used by ST core to set/get the various PM states
390  * of the chip.
391  */
392 unsigned long st_ll_getstate(struct st_data_s *);
393 unsigned long st_ll_sleep_state(struct st_data_s *, unsigned char);
394 void st_ll_wakeup(struct st_data_s *);
395
396 /*
397  * header information used by st_core.c for FM and GPS
398  * packet parsing, the bluetooth headers are already available
399  * at net/bluetooth/
400  */
401
402 struct fm_event_hdr {
403         u8 plen;
404 } __attribute__ ((packed));
405
406 #define FM_MAX_FRAME_SIZE 0xFF  /* TODO: */
407 #define FM_EVENT_HDR_SIZE 1     /* size of fm_event_hdr */
408 #define ST_FM_CH8_PKT 0x8
409
410 /* gps stuff */
411 struct gps_event_hdr {
412         u8 opcode;
413         u16 plen;
414 } __attribute__ ((packed));
415
416 #endif /* TI_WILINK_ST_H */