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.
7 * Copyright (C) 2009-2010 Texas Instruments
8 * Author: Pavan Savoy <pavan_savoy@ti.com>
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.
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.
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
25 #ifndef TI_WILINK_ST_H
26 #define TI_WILINK_ST_H
29 * enum kim_gpio_state - Few protocols such as FM have ACTIVE LOW
30 * gpio states for their chip/core enable gpios
38 * enum proto-type - The protocol on WiLink chips which share a
39 * common physical interface like UART.
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
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.
68 long (*recv) (void *, struct sk_buff *);
69 unsigned char (*match_packet) (const unsigned char *data);
70 void (*reg_complete_cb) (void *, char data);
71 long (*write) (struct sk_buff *skb);
75 extern long st_register(struct st_proto_s *);
76 extern long st_unregister(enum proto_type);
80 * header information used by st_core.c
83 /* states of protocol list */
90 #define ST_INITIALIZING 1
91 #define ST_REG_IN_PROGRESS 2
92 #define ST_REG_PENDING 3
93 #define ST_WAITING_FOR_RESP 4
96 * struct st_data_s - ST core internal structure
97 * @st_state: different states of ST like initializing, registration
98 * in progress, this is mainly used to return relevant err codes
99 * when protocol drivers are registering. It is also used to track
100 * the recv function, as in during fw download only HCI events
101 * can occur , where as during other times other events CH8, CH9
103 * @tty: tty provided by the TTY core for line disciplines.
104 * @ldisc_ops: the procedures that this line discipline registers with TTY.
105 * @tx_skb: If for some reason the tty's write returns lesser bytes written
106 * then to maintain the rest of data to be written on next instance.
107 * This needs to be protected, hence the lock inside wakeup func.
108 * @tx_state: if the data is being written onto the TTY and protocol driver
109 * wants to send more, queue up data and mark that there is
111 * @list: the list of protocols registered, only MAX can exist, one protocol
112 * can register only once.
113 * @rx_state: states to be maintained inside st's tty receive
114 * @rx_count: count to be maintained inside st's tty receieve
115 * @rx_skb: the skb where all data for a protocol gets accumulated,
116 * since tty might not call receive when a complete event packet
117 * is received, the states, count and the skb needs to be maintained.
118 * @txq: the list of skbs which needs to be sent onto the TTY.
119 * @tx_waitq: if the chip is not in AWAKE state, the skbs needs to be queued
120 * up in here, PM(WAKEUP_IND) data needs to be sent and then the skbs
121 * from waitq can be moved onto the txq.
123 * @lock: the lock to protect skbs, queues, and ST states.
124 * @protos_registered: count of the protocols registered, also when 0 the
125 * chip enable gpio can be toggled, and when it changes to 1 the fw
126 * needs to be downloaded to initialize chip side ST.
127 * @ll_state: the various PM states the chip can be, the states are notified
128 * to us, when the chip sends relevant PM packets(SLEEP_IND, WAKE_IND).
129 * @kim_data: reference to the parent encapsulating structure.
133 unsigned long st_state;
134 struct tty_struct *tty;
135 struct tty_ldisc_ops *ldisc_ops;
136 struct sk_buff *tx_skb;
137 #define ST_TX_SENDING 1
138 #define ST_TX_WAKEUP 2
139 unsigned long tx_state;
140 struct st_proto_s *list[ST_MAX];
141 unsigned long rx_state;
142 unsigned long rx_count;
143 struct sk_buff *rx_skb;
144 struct sk_buff_head txq, tx_waitq;
146 unsigned char protos_registered;
147 unsigned long ll_state;
153 * point this to tty->driver->write or tty->ops->write
154 * depending upon the kernel version
156 int st_int_write(struct st_data_s*, const unsigned char*, int);
160 * internal write function, passed onto protocol drivers
161 * via the write function ptr of protocol struct
163 long st_write(struct sk_buff *);
165 /* function to be called from ST-LL */
166 void st_ll_send_frame(enum proto_type, struct sk_buff *);
168 /* internal wake up function */
169 void st_tx_wakeup(struct st_data_s *st_data);
171 /* init, exit entry funcs called from KIM */
172 int st_core_init(struct st_data_s **);
173 void st_core_exit(struct st_data_s *);
175 /* ask for reference from KIM */
176 void st_kim_ref(struct st_data_s **, int);
178 #define GPS_STUB_TEST
180 int gps_chrdrv_stub_write(const unsigned char*, int);
181 void gps_chrdrv_stub_init(void);
185 * header information used by st_kim.c
188 /* time in msec to wait for
189 * line discipline to be installed
191 #define LDISC_TIME 500
192 #define CMD_RESP_TIME 500
193 #define MAKEWORD(a, b) ((unsigned short)(((unsigned char)(a)) \
194 | ((unsigned short)((unsigned char)(b))) << 8))
199 /* the Power-On-Reset logic, requires to attempt
200 * to download firmware onto chip more than once
201 * since the self-test for chip takes a while
203 #define POR_RETRY_COUNT 5
206 * struct chip_version - save the chip version
208 struct chip_version {
211 unsigned short min_ver;
212 unsigned short maj_ver;
216 * struct kim_data_s - the KIM internal data, embedded as the
217 * platform's drv data. One for each ST device in the system.
218 * @uim_pid: KIM needs to communicate with UIM to request to install
219 * the ldisc by opening UART when protocol drivers register.
220 * @kim_pdev: the platform device added in one of the board-XX.c file
221 * in arch/XX/ directory, 1 for each ST device.
222 * @kim_rcvd: completion handler to notify when data was received,
223 * mainly used during fw download, which involves multiple send/wait
224 * for each of the HCI-VS commands.
225 * @ldisc_installed: completion handler to notify that the UIM accepted
226 * the request to install ldisc, notify from tty_open which suggests
227 * the ldisc was properly installed.
228 * @resp_buffer: data buffer for the .bts fw file name.
229 * @fw_entry: firmware class struct to request/release the fw.
230 * @gpios: the list of core/chip enable gpios for BT, FM and GPS cores.
231 * @rx_state: the rx state for kim's receive func during fw download.
232 * @rx_count: the rx count for the kim's receive func during fw download.
233 * @rx_skb: all of fw data might not come at once, and hence data storage for
234 * whole of the fw response, only HCI_EVENTs and hence diff from ST's
236 * @rfkill: rfkill data for each of the cores to be registered with rfkill.
237 * @rf_protos: proto types of the data registered with rfkill sub-system.
238 * @core_data: ST core's data, which mainly is the tty's disc_data
239 * @version: chip version available via a sysfs entry.
244 struct platform_device *kim_pdev;
245 struct completion kim_rcvd, ldisc_installed;
246 char resp_buffer[30];
247 const struct firmware *fw_entry;
249 unsigned long rx_state;
250 unsigned long rx_count;
251 struct sk_buff *rx_skb;
252 struct rfkill *rfkill[ST_MAX];
253 enum proto_type rf_protos[ST_MAX];
254 struct st_data_s *core_data;
255 struct chip_version version;
259 * functions called when 1 of the protocol drivers gets
260 * registered, these need to communicate with UIM to request
261 * ldisc installed, read chip_version, download relevant fw
263 long st_kim_start(void *);
264 long st_kim_stop(void *);
266 void st_kim_recv(void *, const unsigned char *, long count);
267 void st_kim_chip_toggle(enum proto_type, enum kim_gpio_state);
268 void st_kim_complete(void *);
269 void kim_st_list_protocols(struct st_data_s *, void *);
274 #define ACTION_SEND_COMMAND 1
275 #define ACTION_WAIT_EVENT 2
276 #define ACTION_SERIAL 3
277 #define ACTION_DELAY 4
278 #define ACTION_RUN_SCRIPT 5
279 #define ACTION_REMARKS 6
282 * struct bts_header - the fw file is NOT binary which can
283 * be sent onto TTY as is. The .bts is more a script
284 * file which has different types of actions.
285 * Each such action needs to be parsed by the KIM and
286 * relevant procedure to be called.
293 } __attribute__ ((packed));
296 * struct bts_action - Each .bts action has its own type of
303 } __attribute__ ((packed));
305 struct bts_action_send {
307 } __attribute__ ((packed));
309 struct bts_action_wait {
313 } __attribute__ ((packed));
315 struct bts_action_delay {
317 } __attribute__ ((packed));
319 struct bts_action_serial {
322 } __attribute__ ((packed));
325 * struct hci_command - the HCI-VS for intrepreting
326 * the change baud rate of host-side UART, which
327 * needs to be ignored, since UIM would do that
328 * when it receives request from KIM for ldisc installation.
335 } __attribute__ ((packed));
338 * header information used by st_ll.c
341 /* ST LL receiver states */
342 #define ST_W4_PACKET_TYPE 0
343 #define ST_BT_W4_EVENT_HDR 1
344 #define ST_BT_W4_ACL_HDR 2
345 #define ST_BT_W4_SCO_HDR 3
346 #define ST_BT_W4_DATA 4
347 #define ST_FM_W4_EVENT_HDR 5
348 #define ST_GPS_W4_EVENT_HDR 6
350 /* ST LL state machines */
351 #define ST_LL_ASLEEP 0
352 #define ST_LL_ASLEEP_TO_AWAKE 1
353 #define ST_LL_AWAKE 2
354 #define ST_LL_AWAKE_TO_ASLEEP 3
355 #define ST_LL_INVALID 4
357 /* different PM notifications coming from chip */
358 #define LL_SLEEP_IND 0x30
359 #define LL_SLEEP_ACK 0x31
360 #define LL_WAKE_UP_IND 0x32
361 #define LL_WAKE_UP_ACK 0x33
363 /* initialize and de-init ST LL */
364 long st_ll_init(struct st_data_s *);
365 long st_ll_deinit(struct st_data_s *);
368 * enable/disable ST LL along with KIM start/stop
371 void st_ll_enable(struct st_data_s *);
372 void st_ll_disable(struct st_data_s *);
375 * various funcs used by ST core to set/get the various PM states
378 unsigned long st_ll_getstate(struct st_data_s *);
379 unsigned long st_ll_sleep_state(struct st_data_s *, unsigned char);
380 void st_ll_wakeup(struct st_data_s *);
383 * header information used by st_core.c for FM and GPS
384 * packet parsing, the bluetooth headers are already available
388 struct fm_event_hdr {
390 } __attribute__ ((packed));
392 #define FM_MAX_FRAME_SIZE 0xFF /* TODO: */
393 #define FM_EVENT_HDR_SIZE 1 /* size of fm_event_hdr */
394 #define ST_FM_CH8_PKT 0x8
397 struct gps_event_hdr {
400 } __attribute__ ((packed));
402 #endif /* TI_WILINK_ST_H */