platform/inc/stbhwnet.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2009 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
/* pre-processor mechanism so multiple inclusions don't cause compilation error*/
#ifndef _STBHWNET_H
#define _STBHWNET_H


/*---Constant and macro definitions for public use-----------------------------*/
/* the maximum size address string that the API will return */
#ifndef MAX_ADDR_STRING_LEN
#define MAX_ADDR_STRING_LEN 255
#endif

#ifndef SOCK_SETSIZE
#define SOCK_SETSIZE 64
#endif

/* removes socket "sock" from set "set" */
#define SOCK_CLR(sock, set) STB_NWSockClear((sock), (set));

/* adds socket "sock" to set "set" */
#define SOCK_SET(sock, set) STB_NWSockSet((sock), (set));

/* empties set "set" */
#define SOCK_ZERO(set) STB_NWSockZero((set))

/* true if socket "sock" is a member of "set" */
#define SOCK_ISSET(sock, set) STB_NWSockIsSet((sock), (set))

#ifndef INVALID_SOCKET
#define INVALID_SOCKET 0
#endif

/*---Enumerations for public use-----------------------------------------------*/
typedef enum
{
   NW_WIRED,
   NW_WIRELESS
} E_NW_INTERFACE;

typedef enum
{
   NW_AF_INET,
   NW_AF_INET6
} E_NW_AF;

typedef enum
{
   NW_SOCK_STREAM,
   NW_SOCK_DGRAM
} E_NW_TYPE;

typedef enum
{
   NW_PROTOCOL_TCP,
   NW_PROTOCOL_UDP
} E_NW_PROTOCOL;

typedef enum
{
   NW_LINK_ACTIVE,
   NW_LINK_INACTIVE,
   NW_LINK_DISABLED
} E_NW_LINK_STATUS;

typedef enum
{
   NW_OK,
   NW_ERROR,
   NW_BAD_PARAM,
   NW_PENDING
} E_NW_ERROR;

typedef void (*NW_eth_callback)(void);
typedef void *NW_handle;

/*---Global type defs for public use-------------------------------------------*/
typedef struct
{
   U16BIT sock_count;
   void *sock_array[SOCK_SETSIZE];
} S_NW_SOCKSET;

typedef struct
{
   E_NW_AF af;
   E_NW_TYPE type;
   E_NW_PROTOCOL protocol;
   U8BIT addr[48];
} S_NW_ADDR_INFO;

typedef struct
{
   U8BIT *essid;
   U8BIT quality;
   BOOLEAN encrypted;
   BOOLEAN connected;
} S_NW_ACCESS_POINT;

/*---Global Function prototypes for public use---------------------------------*/
BOOLEAN STB_NWInitialise(void);

BOOLEAN STB_NWSelectInterface(E_NW_INTERFACE iface);

E_NW_LINK_STATUS STB_NWGetLinkStatus(void);

NW_handle STB_NWStartEthernetMonitor( NW_eth_callback func );

void STB_NWStopEthernetMonitor( NW_handle hdl );

BOOLEAN STB_NWGetMACAddress(E_NW_INTERFACE iface, U8BIT *mac_addr);

U16BIT STB_NWLookupAddress(U8BIT *name, S_NW_ADDR_INFO **nw_addrs);

void* STB_NWOpenSocket(E_NW_AF af, E_NW_TYPE type, E_NW_PROTOCOL protocol, BOOLEAN nonblock);

BOOLEAN STB_NWCloseSocket(void *socket);

BOOLEAN STB_NWBind(void *socket, U8BIT *address, U32BIT port);

BOOLEAN STB_NWSetReuseaddr(void *socket, BOOLEAN state);

BOOLEAN STB_NWGetReuseaddr(void *socket, BOOLEAN *state);

BOOLEAN STB_NWAddMembership(void *socket, U8BIT *group_address);

BOOLEAN STB_NWDropMembership(void *socket, U8BIT *group_address);

BOOLEAN STB_NWGetSocketName(void *socket, E_NW_AF *af, U8BIT *address, U32BIT *port);

E_NW_ERROR STB_NWConnect(void *socket, U8BIT *address, U32BIT port);

BOOLEAN STB_NWListen(void *socket, S32BIT backlog);

void* STB_NWAccept(void *socket, U8BIT *address, U32BIT *port);

S32BIT STB_NWSend(void *socket, U8BIT *buf, U32BIT num_bytes);

S32BIT STB_NWReceive(void *socket, U8BIT *buf, U32BIT max_bytes);

S32BIT STB_NWReceiveFrom(void *socket, U8BIT *buf, U32BIT max_bytes, U8BIT *address, U32BIT *port);

S32BIT STB_NWSendTo(void *socket, U8BIT *buf, U32BIT num_bytes,
   U8BIT *address, U32BIT port);

BOOLEAN STB_NWSockIsSet(void *socket, S_NW_SOCKSET *socks);

void STB_NWSockZero(S_NW_SOCKSET *socks);

void STB_NWSockClear(void *socket, S_NW_SOCKSET *socks);

void STB_NWSockSet(void *socket, S_NW_SOCKSET *socks);

S32BIT  STB_NWSelect(S_NW_SOCKSET *read_sockets, S_NW_SOCKSET *write_sockets,
   S_NW_SOCKSET *except_sockets, S32BIT timeout_ms);


U16BIT STB_NWGetWirelessAccessPoints(S_NW_ACCESS_POINT **access_points);

void STB_NWFreeWirelessAccessPoints(S_NW_ACCESS_POINT *access_points, U16BIT num_aps);

BOOLEAN STB_NWConnectToAccessPoint(U8BIT *essid, U8BIT *password);


#endif /* _STBHWNET_H */