slnetif.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017-2020, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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                                                             */
/*****************************************************************************/

#ifndef __SL_NET_IF_H__
#define __SL_NET_IF_H__

#include <stdint.h>
#include <stdbool.h>

#include <ti/net/slnetsock.h>

#ifdef    __cplusplus
extern "C" {
#endif

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

/* Interface ID bit pool to be used in interface add and in socket creation  */
#define SLNETIF_ID_1                (1 << 0)  
#define SLNETIF_ID_2                (1 << 1)  
#define SLNETIF_ID_3                (1 << 2)  
#define SLNETIF_ID_4                (1 << 3)  
#define SLNETIF_ID_5                (1 << 4)  
#define SLNETIF_ID_6                (1 << 5)  
#define SLNETIF_ID_7                (1 << 6)  
#define SLNETIF_ID_8                (1 << 7)  
#define SLNETIF_ID_9                (1 << 8)  
#define SLNETIF_ID_10               (1 << 9)  
#define SLNETIF_ID_11               (1 << 10) 
#define SLNETIF_ID_12               (1 << 11) 
#define SLNETIF_ID_13               (1 << 12) 
#define SLNETIF_ID_14               (1 << 13) 
#define SLNETIF_ID_15               (1 << 14) 
#define SLNETIF_ID_16               (1 << 15) 
#define SLNETIF_MAX_IF              (16)      
/* this macro returns 0 when only one bit is set and a number when it isn't */
#define ONLY_ONE_BIT_IS_SET(x)      (((x > 0) && ((x & (x - 1)) == 0))?true:false)


/* Interface connection status bit pool to be used in set interface connection status function */

#define SLNETIF_STATUS_DISCONNECTED (0)
#define SLNETIF_STATUS_CONNECTED    (1)

typedef enum
{
    SLNETIF_STATE_DISABLE = 0,
    SLNETIF_STATE_ENABLE  = 1
} SlNetIfState_e;

typedef enum
{
    SLNETIF_IPV4_ADDR        = 0,
    SLNETIF_IPV6_ADDR_LOCAL  = 1,
    SLNETIF_IPV6_ADDR_GLOBAL = 2
} SlNetIfAddressType_e;

typedef enum
{
    SLNETIF_DISCONNECT = 0,
    SLNETIF_MAC_CONNECT = 1,
    SLNETIF_IP_AQUIRED = 2
} SlNetIfEventId_e;

/* Address config return values that can be retrieved in get ip address function */
#define SLNETIF_ADDR_CFG_UNKNOWN   (0)
#define SLNETIF_ADDR_CFG_DHCP      (1)
#define SLNETIF_ADDR_CFG_DHCP_LLA  (2)
#define SLNETIF_ADDR_CFG_STATIC    (4)
#define SLNETIF_ADDR_CFG_STATELESS (5)
#define SLNETIF_ADDR_CFG_STATEFUL  (6)

/* Security object types for load Sec Obj function */
#define SLNETIF_SEC_OBJ_TYPE_RSA_PRIVATE_KEY (1)
#define SLNETIF_SEC_OBJ_TYPE_CERTIFICATE     (2)
#define SLNETIF_SEC_OBJ_TYPE_DH_KEY          (3)


#define SLNETIF_QUERY_IF_STATE_BIT               (1 << 0)

#define SLNETIF_QUERY_IF_CONNECTION_STATUS_BIT   (1 << 1)

#define SLNETIF_QUERY_IF_ALLOW_PARTIAL_MATCH_BIT (1 << 2)

/*****************************************************************************/
/* Structure/Enum declarations                                               */
/*****************************************************************************/

typedef int32_t (*SlNetIf_Event_t)(SlNetIfEventId_e status, uint16_t ifID , void* pData);

typedef struct SlNetIf_Config_t
{
    /* connection related API's */
    int32_t (*connEnable)        (void *ifContext);                                                                                  
    int16_t (*connDisable)       (void *ifContext);                                                                                  
    /* socket related API's */
    int16_t (*sockCreate)        (void *ifContext, int16_t domain, int16_t type, int16_t protocol, void **sdContext);                
    int32_t (*sockClose)         (int16_t sd, void *sdContext);                                                                      
    int32_t (*sockShutdown)      (int16_t sd, void *sdContext, int16_t how);                                                         
    int16_t (*sockAccept)        (int16_t sd, void *sdContext, SlNetSock_Addr_t *addr, SlNetSocklen_t *addrlen, uint8_t flags, void **acceptedSdContext);        
    int32_t (*sockBind)          (int16_t sd, void *sdContext, const SlNetSock_Addr_t *addr, int16_t addrlen);                       
    int32_t (*sockListen)        (int16_t sd, void *sdContext, int16_t backlog);                                                     
    int32_t (*sockConnect)       (int16_t sd, void *sdContext, const SlNetSock_Addr_t *addr, SlNetSocklen_t addrlen, uint8_t flags); 
    int32_t (*sockGetPeerName)   (int16_t sd, void *sdContext, SlNetSock_Addr_t *addr, SlNetSocklen_t *addrlen);                     
    int32_t (*sockGetLocalName)  (int16_t sd, void *sdContext, SlNetSock_Addr_t *addr, SlNetSocklen_t *addrlen);                     
    int32_t (*sockSelect)        (void *ifContext, int16_t nsds, SlNetSock_SdSet_t *readsds, SlNetSock_SdSet_t *writesds, SlNetSock_SdSet_t *exceptsds, SlNetSock_Timeval_t *timeout); 
    int32_t (*sockSetOpt)        (int16_t sd, void *sdContext, int16_t level, int16_t optname, void *optval, SlNetSocklen_t optlen);                             
    int32_t (*sockGetOpt)        (int16_t sd, void *sdContext, int16_t level, int16_t optname, void *optval, SlNetSocklen_t *optlen);                            
    int32_t (*sockRecv)          (int16_t sd, void *sdContext, void *buf, uint32_t len, uint32_t flags);                                                         
    int32_t (*sockRecvFrom)      (int16_t sd, void *sdContext, void *buf, uint32_t len, uint32_t flags, SlNetSock_Addr_t *from, SlNetSocklen_t *fromlen);        
    int32_t (*sockSend)          (int16_t sd, void *sdContext, const void *buf, uint32_t len, uint32_t flags);                                                   
    int32_t (*sockSendTo)        (int16_t sd, void *sdContext, const void *buf, uint32_t len, uint32_t flags, const SlNetSock_Addr_t *to, SlNetSocklen_t tolen); 
    int32_t (*sockstartSec)      (int16_t sd, void *sdContext, SlNetSockSecAttrib_t *secAttrib, uint8_t flags);                                                  
    /* util related API's */
    int32_t (*utilGetHostByName) (void *ifContext, char *name, const uint16_t nameLen, uint32_t *ipAddr, uint16_t *ipAddrLen, const uint8_t family);  
    uint32_t (*utilPing)         (void *ifContext, const SlNetSock_Addr_t *addr, SlNetSocklen_t addrLen, uint32_t attempts, uint16_t timeout, uint16_t interval, uint16_t packetSize, int16_t flags);  
    /* if related API's */
    int32_t (*ifGetIPAddr)           (void *ifContext, SlNetIfAddressType_e addrType, uint16_t *addrConfig, uint32_t *ipAddr);                      
    int32_t (*ifGetConnectionStatus) (void *ifContext);                                                                                             
    int32_t (*ifLoadSecObj)          (void *ifContext, uint16_t objType, char *objName, int16_t objNameLen, uint8_t *objBuff, int16_t objBuffLen);  
    int32_t (*ifCreateContext)       (uint16_t ifID, const char *ifName, void **ifContext, SlNetIf_Event_t ifCallback);                             
    int32_t (*ifDeleteContext)       (uint16_t ifID, void **ifContext);                                                                             
} SlNetIf_Config_t;


typedef struct SlNetIf_t
{
    uint32_t          ifID;
    char             *ifName;
    int32_t           flags;
    SlNetIf_Config_t *ifConf;
    void             *ifContext;
} SlNetIf_t;

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

int32_t SlNetIf_init(int32_t flags);

int32_t SlNetIf_add(uint16_t ifID, char *ifName, const SlNetIf_Config_t *ifConf, uint8_t priority);


SlNetIf_t * SlNetIf_getIfByID(uint16_t ifID);


SlNetIf_t * SlNetIf_queryIf(uint32_t ifBitmap, uint32_t queryBitmap);


const char * SlNetIf_getNameByID(uint16_t ifID);


int32_t SlNetIf_getIDByName(char *ifName);


int32_t SlNetIf_getPriority(uint16_t ifID);


int32_t SlNetIf_setPriority(uint16_t ifID, uint8_t priority);


int32_t SlNetIf_setState(uint16_t ifID, SlNetIfState_e ifState);


int32_t SlNetIf_getState(uint16_t ifID);


int32_t SlNetIf_getConnectionStatus(uint16_t ifID);


int32_t SlNetIf_getIPAddr(uint16_t ifID, SlNetIfAddressType_e addrType, uint16_t *addrConfig, uint32_t *ipAddr);


int32_t SlNetIf_loadSecObj(uint16_t objType, char *objName, int16_t objNameLen, uint8_t *objBuff, int16_t objBuffLen, uint32_t ifBitmap);

int32_t SlNetIf_registerEventHandler(SlNetIf_Event_t EventCallback);

int32_t SlNetIf_unregisterEventHandler(SlNetIf_Event_t EventCallback);

#ifdef  __cplusplus
}
#endif /* __cplusplus */

#endif /* __SL_NET_IF_H__ */