CC3000 driver changes from David Sidrane

drivers/wireless/cc3000/cc3000.h

+/****************************************************************************
+ * drivers//wireless/cc3000.h
+ *
+ *   Copyright (C) 2011 Gregory Nutt. All rights reserved.
+ *   Authors: Gregory Nutt <gnutt@nuttx.org>
+ *            David Sidrane <david_s5@nscdg.com>
+ *
+ * References:
+ *   CC30000 from Texas Instruments http://processors.wiki.ti.com/index.php/CC3000
+ *
+ * See also:
+ * 		http://processors.wiki.ti.com/index.php/CC3000_Host_Driver_Porting_Guide
+ * 		http://processors.wiki.ti.com/index.php/CC3000_Host_Programming_Guide
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name NuttX nor the names of its contributors may be
+ *    used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ ****************************************************************************/
+
+#ifndef __DRIVERS_WIRELESS_WIRELESS_CC3000_H
+#define __DRIVERS_WIRELESS_WIRELESS_CC3000_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+#include <nuttx/config.h>
+
+#include <stdint.h>
+#include <mqueue.h>
+#include <nuttx/spi/spi.h>
+#include <nuttx/irq.h>
+#include <nuttx/wireless/wireless.h>
+#include <nuttx/wireless/cc3000.h>
+#include "spi.h"
+
+/****************************************************************************
+ * Pre-Processor Definitions
+ ****************************************************************************/
+
+/* CC3000 Interfaces *********************************************************************/
+
+/* Driver support **************************************************************************/
+/* This format is used to construct the /dev/input[n] device driver path.  It
+ * defined here so that it will be used consistently in all places.
+ */
+
+
+/********************************************************************************************
+ * Public Types
+ ********************************************************************************************/
+#define READ                    3
+#define READ_COMMAND		       {READ, 0 , 0 , 0 , 0}
+#define READ_OFFSET_TO_LENGTH   3 //cmd  dmy dmy lh  ll
+#define WRITE                   1
+
+#define HI(value)               (((value) & 0xFF00) >> 8)
+#define LO(value)               ((value) & 0x00FF)
+
+#define SPI_HEADER_SIZE         (5)
+
+
+/* This structure describes the state of one CC3000 driver instance */
+typedef enum {
+		eSPI_STATE_POWERUP = 0,
+		eSPI_STATE_INITIALIZED,
+		eSPI_STATE_IDLE,
+		eSPI_STATE_WRITE_WAIT_IRQ,
+		eSPI_STATE_WRITE_PROCEED,
+		eSPI_STATE_WRITE_DONE,
+		eSPI_STATE_READ_IRQ,
+		eSPI_STATE_READ_PROCEED,
+		eSPI_STATE_READ_READY,
+
+} eDeviceStates;
+
+struct cc3000_dev_s
+{
+#ifdef CONFIG_CC3000_MULTIPLE
+  FAR struct cc3000_dev_s *flink;     /* Supports a singly linked list of drivers */
+#endif
+  uint8_t crefs;                        /* Number of times the device has been opened */
+  uint8_t nwaiters;                     /* Number of threads waiting for CC3000 data */
+  uint8_t minor;                        /* minor */
+  sem_t devsem;                         /* Manages exclusive access to this structure */
+  sem_t waitsem;                        /* Used to wait for the availability of data */
+  sem_t readysem;                        /* Used to wait for Ready Condition from the cc3000 */
+
+  FAR struct cc3000_config_s *config; 	/* Board configuration data */
+  FAR struct spi_dev_s *spi;            /* Saved SPI driver instance */
+  struct work_s work;                   /* Supports the interrupt handling "bottom half" */
+  mqd_t	 queue;							/* For unsolicited data delivery */
+  eDeviceStates state;					/* The device state */
+  uint8_t rx_buffer[CC3000_RX_BUFFER_SIZE];
+  ssize_t rx_buffer_len;
+
+  uint8_t tx_buffer[CC3000_TX_BUFFER_SIZE];
+  ssize_t tx_buffer_len;
+
+  /* The following is a list if poll structures of threads waiting for
+   * driver events. The 'struct pollfd' reference for each open is also
+   * retained in the f_priv field of the 'struct file'.
+   */
+
+#ifndef CONFIG_DISABLE_POLL
+  struct pollfd *fds[CONFIG_CC3000_NPOLLWAITERS];
+#endif
+};
+
+/********************************************************************************************
+ * Public Function Prototypes
+ ********************************************************************************************/
+
+#ifdef __cplusplus
+#define EXTERN extern "C"
+extern "C" {
+#else
+#define EXTERN extern
+#endif
+
+#undef EXTERN
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __DRIVERS_WIRELESS_WIRELESS_CC3000_H */

include/nuttx/wireless/cc3000.h

+/****************************************************************************
+ * include/nuttx/wireless/cc3000.h
+ *
+ *   Copyright (C) 2011 Gregory Nutt. All rights reserved.
+ *   Authors: Gregory Nutt <gnutt@nuttx.org>
+ *            David Sidrane <david_s5@nscdg.com>
+ *
+ * References:
+ *   CC30000 from Texas Instruments http://processors.wiki.ti.com/index.php/CC3000
+ *
+ * See also:
+ * 		http://processors.wiki.ti.com/index.php/CC3000_Host_Driver_Porting_Guide
+ * 		http://processors.wiki.ti.com/index.php/CC3000_Host_Programming_Guide
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name NuttX nor the names of its contributors may be
+ *    used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ ****************************************************************************/
+
+#ifndef __INCLUDE_NUTTX_WIRELESS_CC3000_H
+#define __INCLUDE_NUTTX_WIRELESS_CC3000_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+#include <nuttx/wireless/wireless.h>
+
+/****************************************************************************
+ * Pre-Processor Definitions
+ ****************************************************************************/
+#define DEV_FORMAT   "/dev/wireless%d"
+#define DEV_NAMELEN  16
+#define QUEUE_FORMAT   "wlq%d"
+#define QUEUE_NAMELEN  6
+
+
+/* IOCTL commands */
+
+#define CC3000IOC_GETQUEID         _WLIOC_USER(0x0001)   /* arg: Address of int for number*/
+#define CC3000IOC_COMPLETE	       _WLIOC_USER(0x0002)   /* arg: none resumes the Event WL Asynchronous events */
+
+/****************************************************************************
+ * Public Types
+ ****************************************************************************/
+typedef char *(*tFWPatches)(unsigned long *usLength);
+typedef char *(*tDriverPatches)(unsigned long *usLength);
+typedef char *(*tBootLoaderPatches)(unsigned long *usLength);
+typedef void (*tWlanCB)(long event_type, char * data, unsigned char length );
+typedef long (*tWlanReadInteruptPin)(void);
+typedef void (*tWlanInterruptEnable)(void);
+typedef void (*tWlanInterruptDisable)(void);
+typedef void (*tWriteWlanPin)(unsigned char val);
+
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+
+#ifdef __cplusplus
+#define EXTERN extern "C"
+extern "C" {
+#else
+#define EXTERN extern
+#endif
+
+EXTERN  void wlan_init(		tWlanCB	 	sWlanCB,
+			tFWPatches sFWPatches,
+			tDriverPatches sDriverPatches,
+			tBootLoaderPatches sBootLoaderPatches,
+        tWlanReadInteruptPin  sReadWlanInterruptPin,
+        tWlanInterruptEnable  sWlanInterruptEnable,
+        tWlanInterruptDisable sWlanInterruptDisable,
+        tWriteWlanPin         sWriteWlanPin);
+
+
+/*****************************************************************************
+ *
+ *   CC3000_wlan_init
+ *
+ *   @param  sWlanCB   Asynchronous events callback.
+ *                     0 no event call back.
+ *                   -call back parameters:
+ *                    1) event_type: HCI_EVNT_WLAN_UNSOL_CONNECT connect event,
+ *                      HCI_EVNT_WLAN_UNSOL_DISCONNECT disconnect event,
+ *                      HCI_EVNT_WLAN_ASYNC_SIMPLE_CONFIG_DONE config done,
+ *                      HCI_EVNT_WLAN_UNSOL_DHCP dhcp report,
+ *                      HCI_EVNT_WLAN_ASYNC_PING_REPORT ping report OR
+ *                      HCI_EVNT_WLAN_KEEPALIVE keepalive.
+ *                    2) data: pointer to extra data that received by the event
+ *                      (NULL no data).
+ *                    3) length: data length.
+ *                   -Events with extra data:
+ *                      HCI_EVNT_WLAN_UNSOL_DHCP: 4 bytes IP, 4 bytes Mask,
+ *                      4 bytes default gateway, 4 bytes DHCP server and 4 bytes
+ *                      for DNS server.
+ *                      HCI_EVNT_WLAN_ASYNC_PING_REPORT: 4 bytes Packets sent,
+ *                      4 bytes Packets received, 4 bytes Min round time,
+ *                      4 bytes Max round time and 4 bytes for Avg round time.
+ *
+ *   @param    sFWPatches  0 no patch or pointer to FW patches
+ *   @param    sDriverPatches  0 no patch or pointer to driver patches
+ *   @param    sBootLoaderPatches  0 no patch or pointer to bootloader patches
+ *
+ *   @return   none
+ *
+ *   @sa       wlan_set_event_mask , wlan_start , wlan_stop
+ *
+ *   @brief    Initialize wlan driver
+ *
+ *   @warning This function must be called before ANY other wlan driver function
+ *
+ ****************************************************************************/
+EXTERN  void CC3000_wlan_init(tWlanCB sWlanCB,
+				tFWPatches sFWPatches,
+				tDriverPatches sDriverPatches,
+				tBootLoaderPatches sBootLoaderPatches);
+
+
+/************************************************************************************
+ * Name: wireless_archinitialize
+ *
+ * Description:
+ *   Called to configure wireless module (wireless_archinitialize).
+ *
+ ************************************************************************************/
+
+void wireless_archinitialize(void);
+
+
+#undef EXTERN
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* __INCLUDE_NUTTX_WIRELESS_CC3000_H */

include/nuttx/wireless/cc3000/include/cc3000_upif.h

+/****************************************************************************
+ * include/nuttx/wireless/cc3000/include/cc3000_upif.h
+ *
+ *   Copyright (C) 2011 Gregory Nutt. All rights reserved.
+ *   Authors: Gregory Nutt <gnutt@nuttx.org>
+ *            David Sidrane <david_s5@nscdg.com>
+ *
+ * This is the definition for the interface to the bottom half of the cc3000 driver.
+ * it provides the wiring of the board's GPIO and spi to the cc3000 driver.
+ *
+ * References:
+ *   CC30000 from Texas Instruments http://processors.wiki.ti.com/index.php/CC3000
+ *
+ * See also:
+ * 		http://processors.wiki.ti.com/index.php/CC3000_Host_Driver_Porting_Guide
+ * 		http://processors.wiki.ti.com/index.php/CC3000_Host_Programming_Guide
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in
+ *    the documentation and/or other materials provided with the
+ *    distribution.
+ * 3. Neither the name NuttX nor the names of its contributors may be
+ *    used to endorse or promote products derived from this software
+ *    without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
+ * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+ * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ ****************************************************************************/
+
+#ifndef __INCLUDE_NUTTX_WIRELESS_CC3000_CC3000_INTERNAL_H
+#define __INCLUDE_NUTTX_WIRELESS_CC3000_CC3000_INTERNAL_H
+
+/****************************************************************************
+ * Included Files
+ ****************************************************************************/
+
+#include <nuttx/config.h>
+#include <nuttx/spi/spi.h>
+#include <nuttx/irq.h>
+#include <nuttx/wireless/wireless.h>
+
+#if defined(CONFIG_WIRELESS) && defined(CONFIG_WL_CC3000)
+
+/****************************************************************************
+ * Pre-Processor Definitions
+ ****************************************************************************/
+
+/* Configuration ************************************************************/
+/* SPI Frequency.  Default:  16MHz */
+
+#ifndef CONFIG_CC3000_SPI_FREQUENCY
+#  define CONFIG_CC3000_SPI_FREQUENCY 16000000
+#endif
+
+/* Maximum number of threads than can be waiting for POLL events */
+
+#ifndef CONFIG_CC3000_NPOLLWAITERS
+#  define CONFIG_CC3000_NPOLLWAITERS 2
+#endif
+
+#ifndef CONFIG_CC3000_SPIMODE
+// CPOL = 0, CPHA = 1 Sample Data Falling Edge of Clock
+// See http://processors.wiki.ti.com/index.php/CC3000_Serial_Port_Interface_(SPI)
+#  define CONFIG_CC3000_SPIMODE SPIDEV_MODE0
+#endif
+
+
+/* Check for some required settings.  This can save the user a lot of time
+ * in getting the right configuration.
+ */
+
+#ifdef CONFIG_DISABLE_SIGNALS
+#  error "Signals are required.  CONFIG_DISABLE_SIGNALS must not be selected."
+#endif
+
+#ifndef CONFIG_SCHED_WORKQUEUE
+#  error "Work queue support required.  CONFIG_SCHED_WORKQUEUE must be selected."
+#endif
+
+/****************************************************************************
+ * Public Types
+ ****************************************************************************/
+
+/* A reference to a structure of this type must be passed to the CC3000
+ * driver.  This structure provides information about the configuration
+ * of the CC3000 and provides some board-specific hooks.
+ *
+ * Memory for this structure is provided by the caller.  It is not copied
+ * by the driver and is presumed to persist while the driver is active. The
+ * memory must be writable because, under certain circumstances, the driver
+ * may modify frequency or X plate resistance values.
+ */
+
+struct cc3000_config_s
+{
+  /* Device characterization */
+
+  uint32_t spi_frequency;  /* SPI frequency */
+  uint32_t spi_mode;	   /* SPI mode */
+
+  /* If multiple CC3000 devices are supported, then an IRQ number must
+   * be provided for each so that their interrupts can be distinguished.
+   */
+
+#ifndef CONFIG_CC3000_MULTIPLE
+  int      irq;        /* IRQ number received by interrupt handler. */
+#endif
+
+  /* IRQ/GPIO access callbacks.  These operations all hidden behind
+   * callbacks to isolate the CC3000 driver from differences in GPIO
+   * interrupt handling by varying boards and MCUs.  If possible,
+   * interrupts should be configured on falling edges to detect the Ready Condition
+   * At T2: The normal master SPI write sequence is SPI_CS low, followed by SPI_IRQ low
+   * CC3000 to host, indicating that the CC3000 core module is ready to accept data.
+   *  T2 duration is approximately 7 ms.
+   *
+   *   irq_attach 	- Attach the CC3000 interrupt handler to the GPIO interrupt
+   *   irq_enable  	- Enable or disable the GPIO interrupt
+   *   clear_irq	- Acknowledge/clear any pending GPIO interrupt
+   *   power_enable - Enable or disable Module enable.
+   *   chip_select  - The Chip Select
+   *   busy    		- Return the state of the interrupt GPIO input
+   *
+   */
+
+  int  (*irq_attach)(FAR struct cc3000_config_s *state, xcpt_t isr);
+  void (*irq_enable)(FAR struct cc3000_config_s *state, bool enable);
+  void (*irq_clear)(FAR struct cc3000_config_s *state);
+  void (*power_enable)(FAR struct cc3000_config_s *state,bool enable);
+  void (*chip_select)(FAR struct cc3000_config_s *state,bool enable);
+  bool (*busy)(FAR struct cc3000_config_s *state);
+};
+
+/****************************************************************************
+ * Public Function Prototypes
+ ****************************************************************************/
+
+#ifdef __cplusplus
+#define EXTERN extern "C"
+extern "C" {
+#else
+#define EXTERN extern
+#endif
+
+/****************************************************************************
+ * Name: CC3000_register
+ *
+ * Description:
+ *   Configure the CC3000 to use the provided SPI device instance.  This
+ *   will register the driver as /dev/inputN where N is the minor device
+ *   number
+ *
+ * Input Parameters:
+ *   spi     - An SPI driver instance
+ *   config  - Persistent board configuration data
+ *   minor   - The CC000 device minor number
+ *
+ * Returned Value:
+ *    Pointer to newly allocated cc3000 device structure or NULL on error
+ *    (errno is set accordingly in this case).
+ *
+ ****************************************************************************/
+
+EXTERN  int CC3000_register(FAR struct spi_dev_s *spi,
+                             FAR struct cc3000_config_s *config,
+                             int minor);
+
+
+
+#undef EXTERN
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* CONFIG_WIRELESS && CONFIG_INPUT_CC3000 */
+#endif /* __INCLUDE_NUTTX_WIRELESS_CC3000_CC3000_INTERNAL_H */