device.h

/*
 * device.h - CC31xx/CC32xx Host Driver Implementation
 *
 * Copyright (C) 2017 Texas Instruments Incorporated - https://www.ti.com/ 
 * 
 * 
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions 
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright 
 *    notice, this list of conditions and the following disclaimer.
 *
 *    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.
 *
 *    Neither the name of Texas Instruments Incorporated 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.
 *
*/



/*****************************************************************************/
/* Include files                                                             */
/*****************************************************************************/
#include <ti/drivers/net/wifi/simplelink.h>

#ifndef __DEVICE_H__
#define __DEVICE_H__



#ifdef __cplusplus
extern "C" {
#endif

/*****************************************************************************/
/* Macro declarations                                                        */
/*****************************************************************************/
/* Convert event id to event mask to be used in sl_DeviceEventMaskSet and sl_DeviceEventMaskGet */     
#define SL_DEVICE_EVENT_BIT(EventId)        (SL_WLAN_VAL_2_MASK(EventId,1) )     



typedef enum
{
    SL_DEVICE_EVENT_FATAL_DEVICE_ABORT = 1,
    SL_DEVICE_EVENT_FATAL_DRIVER_ABORT,
    SL_DEVICE_EVENT_FATAL_SYNC_LOSS,
    SL_DEVICE_EVENT_FATAL_NO_CMD_ACK,
    SL_DEVICE_EVENT_FATAL_CMD_TIMEOUT,
    SL_DEVICE_EVENT_RESET_REQUEST,
    SL_DEVICE_EVENT_ERROR,
    SL_DEVICE_EVENT_MAX

} SlDeviceEventId_e;

typedef struct
{
    _i16    Status;
    _u16    Caller;
}SlDeviceEventResetRequest_t;

typedef enum
{
    SL_DEVICE_SOURCE_OTHER,
    SL_DEVICE_SOURCE_WLAN,
    SL_DEVICE_SOURCE_NETCFG,
    SL_DEVICE_SOURCE_NETAPP, 
    SL_DEVICE_SOURCE_SECURITY,

    SL_DEVICE_SOURCE_LAST = 0xFF /* last one */
}SlDeviceSource_e;

typedef struct
{
    SlDeviceSource_e    Source;
    _i16                Code;
}SlDeviceEventError_t;

typedef union
{
    SlDeviceEventResetRequest_t    ResetRequest;
    SlDeviceEventError_t        Error;
}SlDeviceEventData_u;



typedef enum
{
    SL_DEVICE_RESET_REQUEST_CALLER_PROVISIONING,
    SL_DEVICE_RESET_REQUEST_CALLER_PROVISIONING_EXTERNAL_CONFIGURATION,
    SL_DEVICE_RESET_REQUEST_NUM_OF_CALLERS
}SlDeviceResetRequestCaller_e;

typedef struct
{
    _u32                Id;
    SlDeviceEventData_u    Data;
}SlDeviceEvent_t;

void slcb_DeviceEvtHdlr(SlDeviceEvent_t* pEvent);
typedef struct
{
    _u32                Code;
    _u32                Value;
} SlDeviceFatalDeviceAssert_t;


typedef struct
{
    _u32 Code;
} SlDeviceFatalNoCmdAck_t, SlDeviceFatalCmdTimeout_t;


typedef union
{    
    SlDeviceFatalDeviceAssert_t        DeviceAssert;
    SlDeviceFatalNoCmdAck_t            NoCmdAck;
    SlDeviceFatalCmdTimeout_t        CmdTimeout;
}SlDeviceFatalData_u;


typedef struct
{
    _u32                    Id;
    SlDeviceFatalData_u        Data;
}SlDeviceFatal_t;



/*
    Declare the different IDs for sl_DeviceGet and sl_DeviceSet
 */  
#define SL_DEVICE_GENERAL  (1)
#define SL_DEVICE_IOT      (4)
#define SL_DEVICE_STATUS   (2)
#define SL_DEVICE_FIPS     (6)
/*
    Declare the different Options for SL_DEVICE_GENERAL in sl_DeviceGet and sl_DeviceSet
 */  
#define SL_DEVICE_GENERAL_DATE_TIME  (11)
#define SL_DEVICE_GENERAL_PERSISTENT (5)
#define SL_DEVICE_GENERAL_VERSION    (12)
#define SL_DEVICE_FIPS_ZEROIZATION   (20)

/* Under SL_DEVICE_GENERAL - Statistics */
#define SL_DEVICE_STAT_WLAN_RX       (16)
#define SL_DEVICE_STAT_PM            (14)

/*
    Declare the different Options for SL_DEVICE_IOT in sl_DeviceGet and sl_DeviceSet
*/  
#define SL_DEVICE_IOT_UDID              (41)

/* Events list to mask/unmask*/
#define SL_DEVICE_EVENT_CLASS_DEVICE                     (1)
#define SL_DEVICE_EVENT_CLASS_WLAN                       (2)
#define SL_DEVICE_EVENT_CLASS_BSD                        (3)
#define SL_DEVICE_EVENT_CLASS_NETAPP                     (4)
#define SL_DEVICE_EVENT_CLASS_NETCFG                     (5)
#define SL_DEVICE_EVENT_CLASS_FS                         (6)
#define SL_DEVICE_EVENT_CLASS_NETUTIL                     (7)

/******************  SYSCONFIG  ****************/
#define SL_DEVICE_SYSCONFIG_AS_CONFIGURED               (99)

/******************  DEVICE CLASS status ****************/
#define SL_DEVICE_EVENT_DROPPED_DEVICE_ASYNC_GENERAL_ERROR       (0x00000001L)
#define SL_DEVICE_STATUS_DEVICE_SMART_CONFIG_ACTIVE              (0x80000000L)
  
/******************  WLAN CLASS status ****************/
#define SL_DEVICE_EVENT_DROPPED_WLAN_WLANASYNCONNECTEDRESPONSE        (0x00000001L)
#define SL_DEVICE_EVENT_DROPPED_WLAN_WLANASYNCDISCONNECTEDRESPONSE    (0x00000002L)
#define SL_DEVICE_EVENT_DROPPED_WLAN_STA_CONNECTED                    (0x00000004L)
#define SL_DEVICE_EVENT_DROPPED_WLAN_STA_DISCONNECTED                 (0x00000008L)
#define SL_DEVICE_EVENT_DROPPED_WLAN_P2P_DEV_FOUND                    (0x00000010L)
#define SL_DEVICE_EVENT_DROPPED_WLAN_CONNECTION_FAILED                (0x00000020L)
#define SL_DEVICE_EVENT_DROPPED_WLAN_P2P_NEG_REQ_RECEIVED             (0x00000040L)
#define SL_DEVICE_EVENT_DROPPED_WLAN_RX_FILTERS                       (0x00000080L)
                      
/******************  NETAPP CLASS status ****************/
#define SL_DEVICE_EVENT_DROPPED_NETAPP_IPACQUIRED                      (0x00000001L)
#define SL_DEVICE_EVENT_DROPPED_NETAPP_IPACQUIRED_V6                   (0x00000002L)
#define SL_DEVICE_EVENT_DROPPED_NETAPP_IP_LEASED                       (0x00000004L)
#define SL_DEVICE_EVENT_DROPPED_NETAPP_IP_RELEASED                     (0x00000008L)
#define SL_DEVICE_EVENT_DROPPED_NETAPP_IPV4_LOST                       (0x00000010L)
#define SL_DEVICE_EVENT_DROPPED_NETAPP_DHCP_ACQUIRE_TIMEOUT               (0x00000020L)
#define SL_DEVICE_EVENT_DROPPED_NETAPP_IP_COLLISION                    (0x00000040L)
#define SL_DEVICE_EVENT_DROPPED_NETAPP_IPV6_LOST                       (0x00000080L)
                      
/******************  BSD CLASS status ****************/
#define SL_DEVICE_EVENT_DROPPED_SOCKET_TXFAILEDASYNCRESPONSE        (0x00000001L)
  
/******************  FS CLASS  ****************/
  
/*****************************************************************************/
/* Structure/Enum declarations                                               */
/*****************************************************************************/

#ifdef SL_IF_TYPE_UART
typedef struct  
{
    _u32             BaudRate;
    _u8              FlowControlEnable;
    _u8              CommPort;
} SlDeviceUartIfParams_t;
#endif

#ifdef SL_IF_TYPE_UART

#define SL_DEVICE_BAUD_9600        (9600L)
#define SL_DEVICE_BAUD_14400    (14400L)
#define SL_DEVICE_BAUD_19200    (19200L)
#define SL_DEVICE_BAUD_38400    (38400L)
#define SL_DEVICE_BAUD_57600    (57600L)
#define SL_DEVICE_BAUD_115200    (115200L)
#define SL_DEVICE_BAUD_230400    (230400L)
#define SL_DEVICE_BAUD_460800    (460800L)
#define SL_DEVICE_BAUD_921600    (921600L)

#endif

typedef struct
{
    _u32                ChipId;
    _u8                 FwVersion[4];
    _u8                 PhyVersion[4];
    _u8                 NwpVersion[4];
    _u16                RomVersion;
    _u16                Padding;
}SlDeviceVersion_t;


typedef struct  
{
       /* time */
    _u32                tm_sec;
    _u32                tm_min;
    _u32                tm_hour;
       /* date */
    _u32                tm_day; /* 1-31 */
    _u32                tm_mon; /* 1-12 */
    _u32                tm_year; /*  YYYY 4 digits  */
    _u32                tm_week_day; /* not required */
    _u32                tm_year_day; /* not required */ 
    _u32                reserved[3];  
}SlDateTime_t;




/******************************************************************************/
/* Type declarations                                                          */
/******************************************************************************/
typedef struct  
{
    _u32    ChipId;
    _u32    MoreData;
}SlDeviceInitInfo_t;

typedef void (*P_INIT_CALLBACK)(_u32 Status, SlDeviceInitInfo_t *DeviceInitInfo);

/*  Device statistics structs  */
typedef struct
{
    _u32 ReceivedValidPacketsNumber;                    /* sum of the packets that been received OK (include filtered) */
    _u32 ReceivedFcsErrorPacketsNumber;                 /* sum of the packets that been dropped due to FCS error */
    _u32 ReceivedAddressMismatchPacketsNumber;          /* sum of the packets that been received but filtered out by one of the HW filters */
    _i16 AvarageDataCtrlRssi;                           /* average RSSI for all valid data packets received */
    _i16 AvarageMgMntRssi;                              /* average RSSI for all valid management packets received */
    _u16 RateHistogram[SL_WLAN_NUM_OF_RATE_INDEXES];    /* rate histogram for all valid packets received */
    _u16 RssiHistogram[SL_WLAN_SIZE_OF_RSSI_HISTOGRAM]; /* RSSI histogram from -40 until -87 (all below and above\n RSSI will appear in the first and last cells) */
    _u32 StartTimeStamp;                                /* the time stamp started collecting the statistics in uSec */
    _u32 GetTimeStamp;                                  /* the time stamp called the get statistics command */
}SlDeviceGetStat_t;

typedef struct
{
    _u32 Disconnects;         // clear on read - disconnect count
    _u32 TxFramesCount;       // clear on read - Tx Frame count
    _u32 ReceivedBytesCount;  // clear on read
    _u32 reserved[4];         // reserved for additional clear on read statistics
}SlDeviceGetPmStatClrOnRdTypes_t;

/*
 * The following statistics are 64 bits represented as array of two 32 Bit
 * where the first index is the LSB and the second index is MSB.
 *
 * For example: TimeMacAwake[0] = LSB, TimeMacAwake[1] = MSB,
 *              TimeMacSleep[0] = LSB, TimeMacSleep[1] = MSB, etc.
 *  */
typedef struct
{
    _u32 TimeMacAwake[2];
    _u32 TimeMacSleep[2];
    _u32 TimeMacListen11B[2];
    _u32 TimeNWPDeepSleep[2];
    _u32 TimeNWPStandBy[2];
    _u32 TimeNWPAwake[2];
}SlDeviceGetPmStatAcc_t;


typedef struct
{
    SlDeviceGetPmStatClrOnRdTypes_t PmClrOnRd; // Clear on read types
    SlDeviceGetPmStatAcc_t          PmAcc;     // Accumulated types
    _u32                            Reserved[4];
    _u32                            StartTimeStamp;
    _u32                            GetTimeStamp;
}SlDeviceGetPmStat_t;

/*****************************************************************************/
/* Function prototypes                                                       */
/*****************************************************************************/

#if _SL_INCLUDE_FUNC(sl_Start)
_i16 sl_Start(const void* pIfHdl, _i8*  pDevName, const P_INIT_CALLBACK pInitCallBack);
#endif

#if _SL_INCLUDE_FUNC(sl_Stop)
_i16 sl_Stop(const _u16 Timeout);
#endif


#if _SL_INCLUDE_FUNC(sl_DeviceSet)
_i16 sl_DeviceSet(const _u8 DeviceSetId ,const _u8 Option,const _u16 ConfigLen,const _u8 *pValues);
#endif

#if _SL_INCLUDE_FUNC(sl_DeviceGet)
_i16 sl_DeviceGet(const _u8 DeviceGetId, _u8 *pOption,_u16 *pConfigLen, _u8 *pValues);
#endif


#if _SL_INCLUDE_FUNC(sl_DeviceEventMaskSet)
_i16 sl_DeviceEventMaskSet(const _u8 EventClass ,const _u32 Mask);
#endif

#if _SL_INCLUDE_FUNC(sl_DeviceEventMaskGet)
_i16 sl_DeviceEventMaskGet(const _u8 EventClass,_u32 *pMask);
#endif


#if _SL_INCLUDE_FUNC(sl_Task)
void* sl_Task(void* pEntry);
#endif




#ifdef SL_IF_TYPE_UART
#if _SL_INCLUDE_FUNC(sl_DeviceUartSetMode)
_i16 sl_DeviceUartSetMode(const SlDeviceUartIfParams_t* pUartParams);
#endif
#endif

_i32 sl_WifiConfig();

_i16 sl_DeviceStatStart(const _u32 Flags); // start collecting the statistics
_i16 sl_DeviceStatGet(const _u16 ConfigId,_u16 length,void* buffer);
_i16 sl_DeviceStatStop(const _u32 Flags);


#ifdef  __cplusplus
}
#endif /*  __cplusplus */

#endif  /*  __DEVICE_H__ */