netcfg.h

/*
 * netcfg.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 __NETCFG_H__
#define __NETCFG_H__


#ifdef    __cplusplus
extern "C" {
#endif

/*****************************************************************************/
/* Macro declarations                                                        */
/*****************************************************************************/

#define SL_MAC_ADDR_LEN                              (6)
#define SL_IPV6_ADDR_LEN                             (16)
#define SL_IPV4_VAL(add_3,add_2,add_1,add_0)         ((((_u32)add_3 << 24) & 0xFF000000) | (((_u32)add_2 << 16) & 0xFF0000) | (((_u32)add_1 << 8) & 0xFF00) | ((_u32)add_0 & 0xFF) )
#define SL_IPV6_VAL(add_1,add_2)                     ((((_u32)add_1 << 16) & 0xFFFF0000) | (((_u32)add_2 ) & 0x0000FFFF) )
#define SL_IPV4_BYTE(val,index)                      ( (val >> (index*8)) & 0xFF )


#define SL_NETCFG_IF_IPV6_STA_LOCAL                  (0x4)    /* disable ipv6 local */
#define SL_NETCFG_IF_IPV6_STA_GLOBAL                 (0x8)    /* disable ipv6 global */
#define SL_NETCFG_IF_DISABLE_IPV4_DHCP               (0x40)   /* disable ipv4 dhcp */
#define SL_NETCFG_IF_IPV6_LOCAL_STATIC               (0x80)   /* enable ipv6 local static */
#define SL_NETCFG_IF_IPV6_LOCAL_STATELESS            (0x100)  /* enable ipv6 local stateless */
#define SL_NETCFG_IF_IPV6_LOCAL_STATEFUL             (0x200)  /* enable ipv6 local statefull */
#define SL_NETCFG_IF_IPV6_GLOBAL_STATIC              (0x400)  /* enable ipv6 global static */
#define SL_NETCFG_IF_IPV6_GLOBAL_STATEFUL            (0x800)  /* enable ipv6 global statefull */
#define SL_NETCFG_IF_DISABLE_IPV4_LLA                (0x1000) /* disable LLA feature. Relevant only in IPV4 */
#define SL_NETCFG_IF_ENABLE_DHCP_RELEASE             (0x2000) /* Enables DHCP release when WLAN disconnect command is issued */
#define SL_NETCFG_IF_IPV6_GLOBAL_STATELESS           (0x4000) /* enable ipv6 global stateless */
#define SL_NETCFG_IF_DISABLE_FAST_RENEW              (0x8000) /* fast renew disabled */


#define    SL_NETCFG_IF_STATE                        (0)
#define SL_NETCFG_ADDR_DHCP                          (1)
#define SL_NETCFG_ADDR_DHCP_LLA                      (2)
#define SL_NETCFG_ADDR_STATIC                        (4)
#define SL_NETCFG_ADDR_STATELESS                     (5)
#define SL_NETCFG_ADDR_STATEFUL                      (6)
#define SL_NETCFG_ADDR_RELEASE_IP_SET                (7)
#define SL_NETCFG_ADDR_RELEASE_IP_OFF                (8)
#define SL_NETCFG_ADDR_ENABLE_FAST_RENEW             (9)
#define SL_NETCFG_ADDR_DISABLE_FAST_RENEW            (10)
#define SL_NETCFG_ADDR_FAST_RENEW_MODE_NO_WAIT_ACK   (11)
#define SL_NETCFG_ADDR_FAST_RENEW_MODE_WAIT_ACK      (12)


/*****************************************************************************/
/* Structure/Enum declarations                                               */
/*****************************************************************************/
typedef enum
{
    SL_NETCFG_MAC_ADDRESS_SET                   = 1,
    SL_NETCFG_MAC_ADDRESS_GET                   = 2,
    SL_NETCFG_AP_STATIONS_NUM_CONNECTED         = 3,
    SL_NETCFG_AP_STATIONS_INFO_LIST             = 4,
    SL_NETCFG_AP_STATION_DISCONNECT             = 5,
    SL_NETCFG_IF                                = 6,
    SL_NETCFG_IPV4_STA_ADDR_MODE                = 7,
    SL_NETCFG_IPV4_AP_ADDR_MODE                 = 8,
    SL_NETCFG_IPV6_ADDR_LOCAL                   = 9,
    SL_NETCFG_IPV6_ADDR_GLOBAL                  = 10,
    SL_NETCFG_IPV4_DHCP_CLIENT                  = 11,
    SL_NETCFG_IPV4_DNS_CLIENT                   = 12,
    SL_NETCFG_IPV6_DNS_CLIENT                   = 13,
    MAX_SETTINGS = 0xFF
}SlNetCfg_e;

typedef struct
{    
    _u32 DnsSecondServerAddr;
}SlNetCfgIpV4DnsClientArgs_t;

typedef struct
{
    _u32 DnsSecondServerAddr[4];
}SlNetCfgIpV6DnsClientArgs_t;


typedef struct
{    
    _u32  Ip;
    _u32  Gateway;
    _u32  Mask;
    _u32  Dns[2];
    _u32  DhcpServer;
    _u32  LeaseTime;
    _u32  TimeToRenew;
    _u8   DhcpState;
    _u8   Reserved[3];
} SlNetCfgIpv4DhcpClient_t;

typedef enum
{
    SL_NETCFG_DHCP_CLIENT_UNKNOWN = 0,
    SL_NETCFG_DHCP_CLIENT_DISABLED,
    SL_NETCFG_DHCP_CLIENT_ENABLED,
    SL_NETCFG_DHCP_CLIENT_BOUND,
    SL_NETCFG_DHCP_CLIENT_RENEW,
    SL_NETCFG_DHCP_CLIENT_REBIND
}SlNetCfgIpv4DhcpClientState_e;


typedef enum
{
    SL_NETCFG_DHCP_OPT_DISABLE_LLA = 0x2,                   /* 1=LLA disabled, 0=LLA enabled. */
    SL_NETCFG_DHCP_OPT_RELEASE_IP_BEFORE_DISCONNECT = 0x4,  /* 1=DHCP release enabled, 0=DHCP release disabled */
    MAX_SL_NETCFG_DHCP_OPT = 0xFF
} SlNetCfgDhcpOption_e;

typedef struct
{
    _u32  Ip;
    _u32  IpMask;
    _u32  IpGateway;
    _u32  IpDnsServer;
}SlNetCfgIpV4Args_t;

typedef struct
{
    _u32  Ip[4];
    _u32  IpDnsServer[4];
    _u32  IpV6Flags; /* bit 0: Indicate if the address is valid for use in the network (IPv6 DAD completed) . If not, try again later or set a different address. 1=Valid. Relevant for sl_NetCfgGet only. */
}SlNetCfgIpV6Args_t;

#define _SL_NETCFG_IPV6_ADDR_BIT_STATUS     0x01 
#define SL_IS_IPV6_ADDR_VALID(IpV6Flags)    (IpV6Flags & _SL_NETCFG_IPV6_ADDR_BIT_STATUS) 

#define NET_CFG_STA_INFO_STATUS_DHCP_ADDR   1

typedef struct
{
    _u32 Ip;
    _u8  MacAddr[6];
    _u16 Status;
    _u8  Name[32]; 
} SlNetCfgStaInfo_t;

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

#if _SL_INCLUDE_FUNC(sl_NetCfgSet)
_i16 sl_NetCfgSet(const _u16 ConfigId,const _u16 ConfigOpt,const _u16 ConfigLen,const _u8 *pValues);
#endif


#if _SL_INCLUDE_FUNC(sl_NetCfgGet)
_i16 sl_NetCfgGet(const _u16 ConfigId ,_u16 *pConfigOpt, _u16 *pConfigLen, _u8 *pValues);
#endif

#ifdef  __cplusplus
}
#endif /*  __cplusplus */

#endif    /*  __NETCFG_H__ */