staging: ti-st: mv ti_wilink_st header

Move the header to a standard linux device driver location.
This should pave the way for other drivers to be moved into the relevant
directories.

ti_wilink_st.h is a common header file used by the TI's shared transport device
driver for WiLink chipsets. Each individual protocol drivers like bluetooth
driver, FM V4L2 driver and GPS drivers will make use of this header.

Signed-off-by: Pavan Savoy <pavan_savoy@ti.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>

1 files changed, 402 insertions, 0 deletions

diff --git a/include/linux/ti_wilink_st.h b/include/linux/ti_wilink_st.h
new file mode 100644
index 000000000000..2a5acf599598
--- /dev/null
+++ b/include/linux/ti_wilink_st.h
@@ -0,0 +1,402 @@
+/*
+ *  Shared Transport Header file
+ *      To be included by the protocol stack drivers for
+ *      Texas Instruments BT,FM and GPS combo chip drivers
+ *      and also serves the sub-modules of the shared transport driver.
+ *
+ *  Copyright (C) 2009-2010 Texas Instruments
+ *  Author: Pavan Savoy <pavan_savoy@ti.com>
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License version 2 as
+ *  published by the Free Software Foundation.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ *
+ */
+
+#ifndef TI_WILINK_ST_H
+#define TI_WILINK_ST_H
+
+/**
+ * enum kim_gpio_state - Few protocols such as FM have ACTIVE LOW
+ *      gpio states for their chip/core enable gpios
+ */
+enum kim_gpio_state {
+        KIM_GPIO_INACTIVE,
+        KIM_GPIO_ACTIVE,
+};
+
+/**
+ * enum proto-type - The protocol on WiLink chips which share a
+ *      common physical interface like UART.
+ */
+enum proto_type {
+        ST_BT,
+        ST_FM,
+        ST_GPS,
+        ST_MAX,
+};
+
+/**
+ * struct st_proto_s - Per Protocol structure from BT/FM/GPS to ST
+ * @type: type of the protocol being registered among the
+ *      available proto_type(BT, FM, GPS the protocol which share TTY).
+ * @recv: the receiver callback pointing to a function in the
+ *      protocol drivers called by the ST driver upon receiving
+ *      relevant data.
+ * @match_packet: reserved for future use, to make ST more generic
+ * @reg_complete_cb: callback handler pointing to a function in protocol
+ *      handler called by ST when the pending registrations are complete.
+ *      The registrations are marked pending, in situations when fw
+ *      download is in progress.
+ * @write: pointer to function in ST provided to protocol drivers from ST,
+ *      to be made use when protocol drivers have data to send to TTY.
+ * @priv_data: privdate data holder for the protocol drivers, sent
+ *      from the protocol drivers during registration, and sent back on
+ *      reg_complete_cb and recv.
+ */
+struct st_proto_s {
+        enum proto_type type;
+        long (*recv) (void *, struct sk_buff *);
+        unsigned char (*match_packet) (const unsigned char *data);
+        void (*reg_complete_cb) (void *, char data);
+        long (*write) (struct sk_buff *skb);
+        void *priv_data;
+};
+
+extern long st_register(struct st_proto_s *);
+extern long st_unregister(enum proto_type);
+
+
+/*
+ * header information used by st_core.c
+ */
+
+/* states of protocol list */
+#define ST_NOTEMPTY     1
+#define ST_EMPTY        0
+
+/*
+ * possible st_states
+ */
+#define ST_INITIALIZING         1
+#define ST_REG_IN_PROGRESS      2
+#define ST_REG_PENDING          3
+#define ST_WAITING_FOR_RESP     4
+
+/**
+ * struct st_data_s - ST core internal structure
+ * @st_state: different states of ST like initializing, registration
+ *      in progress, this is mainly used to return relevant err codes
+ *      when protocol drivers are registering. It is also used to track
+ *      the recv function, as in during fw download only HCI events
+ *      can occur , where as during other times other events CH8, CH9
+ *      can occur.
+ * @tty: tty provided by the TTY core for line disciplines.
+ * @ldisc_ops: the procedures that this line discipline registers with TTY.
+ * @tx_skb: If for some reason the tty's write returns lesser bytes written
+ *      then to maintain the rest of data to be written on next instance.
+ *      This needs to be protected, hence the lock inside wakeup func.
+ * @tx_state: if the data is being written onto the TTY and protocol driver
+ *      wants to send more, queue up data and mark that there is
+ *      more data to send.
+ * @list: the list of protocols registered, only MAX can exist, one protocol
+ *      can register only once.
+ * @rx_state: states to be maintained inside st's tty receive
+ * @rx_count: count to be maintained inside st's tty receieve
+ * @rx_skb: the skb where all data for a protocol gets accumulated,
+ *      since tty might not call receive when a complete event packet
+ *      is received, the states, count and the skb needs to be maintained.
+ * @txq: the list of skbs which needs to be sent onto the TTY.
+ * @tx_waitq: if the chip is not in AWAKE state, the skbs needs to be queued
+ *      up in here, PM(WAKEUP_IND) data needs to be sent and then the skbs
+ *      from waitq can be moved onto the txq.
+ *      Needs locking too.
+ * @lock: the lock to protect skbs, queues, and ST states.
+ * @protos_registered: count of the protocols registered, also when 0 the
+ *      chip enable gpio can be toggled, and when it changes to 1 the fw
+ *      needs to be downloaded to initialize chip side ST.
+ * @ll_state: the various PM states the chip can be, the states are notified
+ *      to us, when the chip sends relevant PM packets(SLEEP_IND, WAKE_IND).
+ * @kim_data: reference to the parent encapsulating structure.
+ *
+ */
+struct st_data_s {
+        unsigned long st_state;
+        struct tty_struct *tty;
+        struct tty_ldisc_ops *ldisc_ops;
+        struct sk_buff *tx_skb;
+#define ST_TX_SENDING   1
+#define ST_TX_WAKEUP    2
+        unsigned long tx_state;
+        struct st_proto_s *list[ST_MAX];
+        unsigned long rx_state;
+        unsigned long rx_count;
+        struct sk_buff *rx_skb;
+        struct sk_buff_head txq, tx_waitq;
+        spinlock_t lock;
+        unsigned char   protos_registered;
+        unsigned long ll_state;
+        void *kim_data;
+};
+
+/**
+ * st_int_write -
+ * point this to tty->driver->write or tty->ops->write
+ * depending upon the kernel version
+ */
+int st_int_write(struct st_data_s*, const unsigned char*, int);
+
+/**
+ * st_write -
+ * internal write function, passed onto protocol drivers
+ * via the write function ptr of protocol struct
+ */
+long st_write(struct sk_buff *);
+
+/* function to be called from ST-LL */
+void st_ll_send_frame(enum proto_type, struct sk_buff *);
+
+/* internal wake up function */
+void st_tx_wakeup(struct st_data_s *st_data);
+
+/* init, exit entry funcs called from KIM */
+int st_core_init(struct st_data_s **);
+void st_core_exit(struct st_data_s *);
+
+/* ask for reference from KIM */
+void st_kim_ref(struct st_data_s **, int);
+
+#define GPS_STUB_TEST
+#ifdef GPS_STUB_TEST
+int gps_chrdrv_stub_write(const unsigned char*, int);
+void gps_chrdrv_stub_init(void);
+#endif
+
+/*
+ * header information used by st_kim.c
+ */
+
+/* time in msec to wait for
+ * line discipline to be installed
+ */
+#define LDISC_TIME      500