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 #include <linux/skbuff.h>
  29
  30 /**
  31  * enum proto-type - The protocol on WiLink chips which share a
  32  *      common physical interface like UART.
  33  */
  34 enum proto_type {
  35         ST_BT,
  36         ST_FM,
  37         ST_GPS,
  38         ST_MAX_CHANNELS = 16,
  39 };
  40
  41 /**
  42  * struct st_proto_s - Per Protocol structure from BT/FM/GPS to ST
  43  * @type: type of the protocol being registered among the
  44  *      available proto_type(BT, FM, GPS the protocol which share TTY).
  45  * @recv: the receiver callback pointing to a function in the
  46  *      protocol drivers called by the ST driver upon receiving
  47  *      relevant data.
  48  * @match_packet: reserved for future use, to make ST more generic
  49  * @reg_complete_cb: callback handler pointing to a function in protocol
  50  *      handler called by ST when the pending registrations are complete.
  51  *      The registrations are marked pending, in situations when fw
  52  *      download is in progress.
  53  * @write: pointer to function in ST provided to protocol drivers from ST,
  54  *      to be made use when protocol drivers have data to send to TTY.
  55  * @priv_data: privdate data holder for the protocol drivers, sent
  56  *      from the protocol drivers during registration, and sent back on
  57  *      reg_complete_cb and recv.
  58  * @chnl_id: channel id the protocol driver is interested in, the channel
  59  *      id is nothing but the 1st byte of the packet in UART frame.
  60  * @max_frame_size: size of the largest frame the protocol can receive.
  61  * @hdr_len: length of the header structure of the protocol.
  62  * @offset_len_in_hdr: this provides the offset of the length field in the
  63  *      header structure of the protocol header, to assist ST to know
  64  *      how much to receive, if the data is split across UART frames.
  65  * @len_size: whether the length field inside the header is 2 bytes
  66  *      or 1 byte.
  67  * @reserve: the number of bytes ST needs to reserve in the skb being
  68  *      prepared for the protocol driver.
  69  */
  70 struct st_proto_s {
  71         enum proto_type type;
  72         long (*recv) (void *, struct sk_buff *);
  73         unsigned char (*match_packet) (const unsigned char *data);
  74         void (*reg_complete_cb) (void *, int data);
  75         long (*write) (struct sk_buff *skb);
  76         void *priv_data;
  77
  78         unsigned char chnl_id;
  79         unsigned short max_frame_size;
  80         unsigned char hdr_len;
  81         unsigned char offset_len_in_hdr;
  82         unsigned char len_size;
  83         unsigned char reserve;
  84 };
  85
  86 extern long st_register(struct st_proto_s *);
  87 extern long st_unregister(struct st_proto_s *);
  88
  89
  90 /*
  91  * header information used by st_core.c
  92  */
  93
  94 /* states of protocol list */
  95 #define ST_NOTEMPTY     1
  96 #define ST_EMPTY        0
  97
  98 /*
  99  * possible st_states
 100  */
 101 #define ST_INITIALIZING         1
 102 #define ST_REG_IN_PROGRESS      2
 103 #define ST_REG_PENDING          3
 104 #define ST_WAITING_FOR_RESP     4
 105
 106 /**
 107  * struct st_data_s - ST core internal structure
 108  * @st_state: different states of ST like initializing, registration
 109  *      in progress, this is mainly used to return relevant err codes
 110  *      when protocol drivers are registering. It is also used to track
 111  *      the recv function, as in during fw download only HCI events
 112  *      can occur , where as during other times other events CH8, CH9
 113  *      can occur.
 114  * @tty: tty provided by the TTY core for line disciplines.
 115  * @tx_skb: If for some reason the tty's write returns lesser bytes written
 116  *      then to maintain the rest of data to be written on next instance.
 117  *      This needs to be protected, hence the lock inside wakeup func.
 118  * @tx_state: if the data is being written onto the TTY and protocol driver
 119  *      wants to send more, queue up data and mark that there is
 120  *      more data to send.
 121  * @list: the list of protocols registered, only MAX can exist, one protocol
 122  *      can register only once.
 123  * @rx_state: states to be maintained inside st's tty receive
 124  * @rx_count: count to be maintained inside st's tty receieve
 125  * @rx_skb: the skb where all data for a protocol gets accumulated,
 126  *      since tty might not call receive when a complete event packet
 127  *      is received, the states, count and the skb needs to be maintained.
 128  * @rx_chnl: the channel ID for which the data is getting accumalated for.
 129  * @txq: the list of skbs which needs to be sent onto the TTY.
 130  * @tx_waitq: if the chip is not in AWAKE state, the skbs needs to be queued
 131  *      up in here, PM(WAKEUP_IND) data needs to be sent and then the skbs
 132  *      from waitq can be moved onto the txq.
 133  *      Needs locking too.
 134  * @lock: the lock to protect skbs, queues, and ST states.
 135  * @protos_registered: count of the protocols registered, also when 0 the
 136  *      chip enable gpio can be toggled, and when it changes to 1 the fw
 137  *      needs to be downloaded to initialize chip side ST.
 138  * @ll_state: the various PM states the chip can be, the states are notified
 139  *      to us, when the chip sends relevant PM packets(SLEEP_IND, WAKE_IND).
 140  * @kim_data: reference to the parent encapsulating structure.
 141  *
 142  */
 143 struct st_data_s {
 144         unsigned long st_state;
 145         struct sk_buff *tx_skb;
 146 #define ST_TX_SENDING   1
 147 #define ST_TX_WAKEUP    2
 148         unsigned long tx_state;
 149         struct st_proto_s *list[ST_MAX_CHANNELS];
 150         bool is_registered[ST_MAX_CHANNELS];
 151         unsigned long rx_state;
 152         unsigned long rx_count;
 153         struct sk_buff *rx_skb;
 154         unsigned char rx_chnl;
 155         struct sk_buff_head txq, tx_waitq;
 156         spinlock_t lock;
 157         unsigned char   protos_registered;
 158         unsigned long ll_state;
 159         void *kim_data;
 160         struct tty_struct *tty;
 161         struct work_struct work_write_wakeup;
 162 };
 163
 164 /*
 165  * wrapper around tty->ops->write_room to check
 166  * availability during firmware download
 167  */
 168 int st_get_uart_wr_room(struct st_data_s *st_gdata);
 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      1000
 210 #define CMD_RESP_TIME   800
 211 #define CMD_WR_TIME     5000
 212 #define MAKEWORD(a, b)  ((unsigned short)(((unsigned char)(a)) \
 213         | ((unsigned short)((unsigned char)(b))) << 8))
 214
 215 #define GPIO_HIGH 1
 216 #define GPIO_LOW  0
 217
 218 /* the Power-On-Reset logic, requires to attempt
 219  * to download firmware onto chip more than once
 220  * since the self-test for chip takes a while
 221  */
 222 #define POR_RETRY_COUNT 5
 223
 224 /**
 225  * struct chip_version - save the chip version
 226  */
 227 struct chip_version {
 228         unsigned short full;
 229         unsigned short chip;
 230         unsigned short min_ver;
 231         unsigned short maj_ver;
 232 };
 233
 234 #define UART_DEV_NAME_LEN 32
 235 /**
 236  * struct kim_data_s - the KIM internal data, embedded as the
 237  *      platform's drv data. One for each ST device in the system.
 238  * @uim_pid: KIM needs to communicate with UIM to request to install
 239  *      the ldisc by opening UART when protocol drivers register.
 240  * @kim_pdev: the platform device added in one of the board-XX.c file
 241  *      in arch/XX/ directory, 1 for each ST device.
 242  * @kim_rcvd: completion handler to notify when data was received,
 243  *      mainly used during fw download, which involves multiple send/wait
 244  *      for each of the HCI-VS commands.
 245  * @ldisc_installed: completion handler to notify that the UIM accepted
 246  *      the request to install ldisc, notify from tty_open which suggests
 247  *      the ldisc was properly installed.
 248  * @resp_buffer: data buffer for the .bts fw file name.
 249  * @fw_entry: firmware class struct to request/release the fw.
 250  * @rx_state: the rx state for kim's receive func during fw download.
 251  * @rx_count: the rx count for the kim's receive func during fw download.
 252  * @rx_skb: all of fw data might not come at once, and hence data storage for
 253  *      whole of the fw response, only HCI_EVENTs and hence diff from ST's
 254  *      response.
 255  * @core_data: ST core's data, which mainly is the tty's disc_data
 256  * @version: chip version available via a sysfs entry.
 257  *
 258  */
 259 struct kim_data_s {
 260         long uim_pid;
 261         struct platform_device *kim_pdev;
 262         struct completion kim_rcvd, ldisc_installed;
 263         char resp_buffer[30];
 264         const struct firmware *fw_entry;
 265         unsigned nshutdown;
 266         unsigned long rx_state;
 267         unsigned long rx_count;
 268         struct sk_buff *rx_skb;
 269         struct st_data_s *core_data;
 270         struct chip_version version;
 271         unsigned char ldisc_install;
 272         unsigned char dev_name[UART_DEV_NAME_LEN + 1];
 273         unsigned flow_cntrl;
 274         unsigned baud_rate;
 275 };
 276
 277 /**
 278  * functions called when 1 of the protocol drivers gets
 279  * registered, these need to communicate with UIM to request
 280  * ldisc installed, read chip_version, download relevant fw
 281  */
 282 long st_kim_start(void *);
 283 long st_kim_stop(void *);
 284
 285 void st_kim_complete(void *);
 286 void kim_st_list_protocols(struct st_data_s *, void *);
 287 void st_kim_recv(void *, const unsigned char *, long);
 288
 289
 290 /*
 291  * BTS headers
 292  */
 293 #define ACTION_SEND_COMMAND     1
 294 #define ACTION_WAIT_EVENT       2
 295 #define ACTION_SERIAL           3
 296 #define ACTION_DELAY            4
 297 #define ACTION_RUN_SCRIPT       5
 298 #define ACTION_REMARKS          6
 299
 300 /**
 301  * struct bts_header - the fw file is NOT binary which can
 302  *      be sent onto TTY as is. The .bts is more a script
 303  *      file which has different types of actions.
 304  *      Each such action needs to be parsed by the KIM and
 305  *      relevant procedure to be called.
 306  */
 307 struct bts_header {
 308         u32 magic;
 309         u32 version;
 310         u8 future[24];
 311         u8 actions[0];
 312 } __attribute__ ((packed));
 313
 314 /**
 315  * struct bts_action - Each .bts action has its own type of
 316  *      data.
 317  */
 318 struct bts_action {
 319         u16 type;
 320         u16 size;
 321         u8 data[0];
 322 } __attribute__ ((packed));
 323
 324 struct bts_action_send {
 325         u8 data[0];
 326 } __attribute__ ((packed));
 327
 328 struct bts_action_wait {
 329         u32 msec;
 330         u32 size;
 331         u8 data[0];
 332 } __attribute__ ((packed));
 333
 334 struct bts_action_delay {
 335         u32 msec;
 336 } __attribute__ ((packed));
 337
 338 struct bts_action_serial {
 339         u32 baud;
 340         u32 flow_control;
 341 } __attribute__ ((packed));
 342
 343 /**
 344  * struct hci_command - the HCI-VS for intrepreting
 345  *      the change baud rate of host-side UART, which
 346  *      needs to be ignored, since UIM would do that
 347  *      when it receives request from KIM for ldisc installation.
 348  */
 349 struct hci_command {
 350         u8 prefix;
 351         u16 opcode;
 352         u8 plen;
 353         u32 speed;
 354 } __attribute__ ((packed));
 355
 356 /*
 357  * header information used by st_ll.c
 358  */
 359
 360 /* ST LL receiver states */
 361 #define ST_W4_PACKET_TYPE       0
 362 #define ST_W4_HEADER            1
 363 #define ST_W4_DATA              2
 364
 365 /* ST LL state machines */
 366 #define ST_LL_ASLEEP               0
 367 #define ST_LL_ASLEEP_TO_AWAKE      1
 368 #define ST_LL_AWAKE                2
 369 #define ST_LL_AWAKE_TO_ASLEEP      3
 370 #define ST_LL_INVALID              4
 371
 372 /* different PM notifications coming from chip */
 373 #define LL_SLEEP_IND    0x30
 374 #define LL_SLEEP_ACK    0x31
 375 #define LL_WAKE_UP_IND  0x32
 376 #define LL_WAKE_UP_ACK  0x33
 377
 378 /* initialize and de-init ST LL */
 379 long st_ll_init(struct st_data_s *);
 380 long st_ll_deinit(struct st_data_s *);
 381
 382 /**
 383  * enable/disable ST LL along with KIM start/stop
 384  * called by ST Core
 385  */
 386 void st_ll_enable(struct st_data_s *);
 387 void st_ll_disable(struct st_data_s *);
 388
 389 /**
 390  * various funcs used by ST core to set/get the various PM states
 391  * of the chip.
 392  */
 393 unsigned long st_ll_getstate(struct st_data_s *);
 394 unsigned long st_ll_sleep_state(struct st_data_s *, unsigned char);
 395 void st_ll_wakeup(struct st_data_s *);
 396
 397 /*
 398  * header information used by st_core.c for FM and GPS
 399  * packet parsing, the bluetooth headers are already available
 400  * at net/bluetooth/
 401  */
 402
 403 struct fm_event_hdr {
 404         u8 plen;
 405 } __attribute__ ((packed));
 406
 407 #define FM_MAX_FRAME_SIZE 0xFF  /* TODO: */
 408 #define FM_EVENT_HDR_SIZE 1     /* size of fm_event_hdr */
 409 #define ST_FM_CH8_PKT 0x8
 410
 411 /* gps stuff */
 412 struct gps_event_hdr {
 413         u8 opcode;
 414         u16 plen;
 415 } __attribute__ ((packed));
 416
 417 /**
 418  * struct ti_st_plat_data - platform data shared between ST driver and
 419  *      platform specific board file which adds the ST device.
 420  * @nshutdown_gpio: Host's GPIO line to which chip's BT_EN is connected.
 421  * @dev_name: The UART/TTY name to which chip is interfaced. (eg: /dev/ttyS1)
 422  * @flow_cntrl: Should always be 1, since UART's CTS/RTS is used for PM
 423  *      purposes.
 424  * @baud_rate: The baud rate supported by the Host UART controller, this will
 425  *      be shared across with the chip via a HCI VS command from User-Space Init
 426  *      Mgr application.
 427  * @suspend:
 428  * @resume: legacy PM routines hooked to platform specific board file, so as
 429  *      to take chip-host interface specific action.
 430  * @chip_enable:
 431  * @chip_disable: Platform/Interface specific mux mode setting, GPIO
 432  *      configuring, Host side PM disabling etc.. can be done here.
 433  * @chip_asleep:
 434  * @chip_awake: Chip specific deep sleep states is communicated to Host
 435  *      specific board-xx.c to take actions such as cut UART clocks when chip
 436  *      asleep or run host faster when chip awake etc..
 437  *
 438  */
 439 struct ti_st_plat_data {
 440         u32 nshutdown_gpio;
 441         unsigned char dev_name[UART_DEV_NAME_LEN]; /* uart name */
 442         u32 flow_cntrl; /* flow control flag */
 443         u32 baud_rate;
 444         int (*suspend)(struct platform_device *, pm_message_t);
 445         int (*resume)(struct platform_device *);
 446         int (*chip_enable) (struct kim_data_s *);
 447         int (*chip_disable) (struct kim_data_s *);
 448         int (*chip_asleep) (struct kim_data_s *);
 449         int (*chip_awake) (struct kim_data_s *);
 450 };
 451
 452 #endif /* TI_WILINK_ST_H */