fnet_netif.h

 /**************************************************************************

 *

 * Copyright 2011-2016 by Andrey Butok. FNET Community.

 * Copyright 2008-2010 by Andrey Butok. Freescale Semiconductor, Inc.

 * Copyright 2003 by Andrey Butok, Alexey Shervashidze. Motorola SPS

 *

 ***************************************************************************

 *

 * Licensed under the Apache License, Version 2.0 (the "License"); you may

 * not use this file except in compliance with the License.

 * You may obtain a copy of the License at

 *

 * http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 *

 ***************************************************************************

 *

 * FNET Network interface API.

 *

 ***************************************************************************/

 

 #ifndef _FNET_NETIF_H_

 

 #define _FNET_NETIF_H_

 

 #include "fnet_ip4.h"

 #include "fnet_ip6.h"

 #include "fnet_eth.h"

 #include "fnet_socket.h"

 

 /**************************************************************************/

 typedef enum

 {

  FNET_NETIF_TYPE_OTHER = 0,

  FNET_NETIF_TYPE_ETHERNET,

  FNET_NETIF_TYPE_WIFI,

  FNET_NETIF_TYPE_LOOPBACK

 } fnet_netif_type_t;

 

 /**************************************************************************/

 struct fnet_netif_statistics

 {

  fnet_uint32_t tx_packet;

  fnet_uint32_t rx_packet;

 };

 

 /**************************************************************************/

 #define FNET_NETIF_NAMELEN (8U)

 

 /**************************************************************************/

 typedef void *fnet_netif_desc_t;

 

 #define FNET_NETIF_LL_ADDR_MAX (16)

 /**************************************************************************/

 typedef fnet_uint8_t fnet_netif_ll_addr_t[FNET_NETIF_LL_ADDR_MAX];

 

 /**************************************************************************/

 #define FNET_NETIF_LL_ADDR_COPY(from_addr, to_addr, ll_size) \

  (fnet_memcpy(&(to_addr)[0], &(from_addr)[0], (ll_size)))

 

 /**************************************************************************/

 #define FNET_NETIF_LL_ADDR_ARE_EQUAL(a, b, size) \

  (fnet_memcmp(&(a)[0], &(b)[0], (size)) == 0)

 

 /**************************************************************************/

 typedef enum

 {

  FNET_NETIF_IP6_ADDR_STATE_NOT_USED = 0,

  FNET_NETIF_IP6_ADDR_STATE_TENTATIVE = 1,

  FNET_NETIF_IP6_ADDR_STATE_PREFERRED = 2

 } fnet_netif_ip6_addr_state_t;

 

 /**************************************************************************/

 typedef enum

 {

  FNET_NETIF_IP_ADDR_TYPE_MANUAL = 0,

  FNET_NETIF_IP_ADDR_TYPE_AUTOCONFIGURABLE = 1,

  FNET_NETIF_IP_ADDR_TYPE_DHCP = 2

 } fnet_netif_ip_addr_type_t;

 

 /**************************************************************************/

 typedef struct fnet_netif_ip6_addr_info

 {

  fnet_ip6_addr_t address;

  fnet_netif_ip6_addr_state_t state;

  fnet_netif_ip_addr_type_t type;

 } fnet_netif_ip6_addr_info_t;

 

 /**************************************************************************/

 typedef struct fnet_netif_ip6_prefix

 {

  fnet_ip6_addr_t prefix;

  fnet_size_t prefix_length;

 } fnet_netif_ip6_prefix_t;

 

 /**************************************************************************/

 typedef struct fnet_netif_ip6_neighbor_cache

 {

  fnet_ip6_addr_t ip_addr;

  fnet_netif_ll_addr_t ll_addr;

  fnet_size_t ll_addr_size;

  fnet_bool_t is_router;

 } fnet_netif_ip6_neighbor_cache_t;

 

 #if defined(__cplusplus)

 extern "C" {

 #endif

 

 /***************************************************************************/

 fnet_netif_desc_t fnet_netif_get_by_name( const fnet_char_t *name );

 

 /***************************************************************************/

 fnet_netif_desc_t fnet_netif_get_by_number( fnet_index_t n );

 

 /***************************************************************************/

 fnet_netif_desc_t fnet_netif_get_by_ip4_addr( fnet_ip4_addr_t addr );

 

 /***************************************************************************/

 void fnet_netif_get_name( fnet_netif_desc_t netif_desc, fnet_char_t *name, fnet_size_t name_size );

 

 /***************************************************************************/

 void fnet_netif_set_default( fnet_netif_desc_t netif_desc );

 

 /***************************************************************************/

 fnet_netif_desc_t fnet_netif_get_default( void );

 

 /***************************************************************************/

 void fnet_netif_set_ip4_addr( fnet_netif_desc_t netif_desc, fnet_ip4_addr_t ipaddr, fnet_ip4_addr_t subnet_mask);

 

 /***************************************************************************/

 fnet_ip4_addr_t fnet_netif_get_ip4_addr( fnet_netif_desc_t netif_desc );

 

 /***************************************************************************/

 void fnet_netif_set_ip4_subnet_mask( fnet_netif_desc_t netif_desc, fnet_ip4_addr_t subnet_mask );

 

 /***************************************************************************/

 fnet_ip4_addr_t fnet_netif_get_ip4_subnet_mask( fnet_netif_desc_t netif_desc );

 

 /***************************************************************************/

 void fnet_netif_set_ip4_gateway( fnet_netif_desc_t netif_desc, fnet_ip4_addr_t gw );

 

 /***************************************************************************/

 fnet_ip4_addr_t fnet_netif_get_ip4_gateway( fnet_netif_desc_t netif_desc );

 

 

 #if FNET_CFG_DNS || defined(__DOXYGEN__)

 /***************************************************************************/

 void fnet_netif_set_ip4_dns( fnet_netif_desc_t netif_desc, fnet_ip4_addr_t dns );

 

 /***************************************************************************/

 fnet_ip4_addr_t fnet_netif_get_ip4_dns( fnet_netif_desc_t netif_desc );

 

 #endif /*FNET_CFG_DNS*/

 

 /***************************************************************************/

 fnet_return_t fnet_netif_set_hw_addr( fnet_netif_desc_t netif_desc, fnet_uint8_t *hw_addr, fnet_size_t hw_addr_size );

 

 /***************************************************************************/

 fnet_return_t fnet_netif_get_hw_addr( fnet_netif_desc_t netif_desc, fnet_uint8_t *hw_addr, fnet_size_t hw_addr_size );

 

 /***************************************************************************/

 fnet_netif_type_t fnet_netif_get_type( fnet_netif_desc_t netif_desc );

 

 /***************************************************************************/

 fnet_netif_ip_addr_type_t fnet_netif_get_ip4_addr_type( fnet_netif_desc_t netif_desc );

 

 /***************************************************************************/

 void fnet_netif_set_ip4_addr_type( fnet_netif_desc_t netif_desc, fnet_netif_ip_addr_type_t ipaddr_type );

 

 /***************************************************************************/

 fnet_bool_t fnet_netif_is_connected( fnet_netif_desc_t netif_desc );

 

 /***************************************************************************/

 fnet_return_t fnet_netif_get_statistics( fnet_netif_desc_t netif_desc, struct fnet_netif_statistics *statistics );

 

 /**************************************************************************/

 typedef void(*fnet_netif_callback_ip4_addr_conflict_t)( fnet_netif_desc_t netif );

 

 /***************************************************************************/

 void fnet_netif_set_callback_on_ip4_addr_conflict (fnet_netif_callback_ip4_addr_conflict_t callback);

 

 /***************************************************************************/

 fnet_bool_t fnet_netif_is_ip4_addr_conflict(fnet_netif_desc_t netif_desc);

 

 /***************************************************************************/

 void fnet_netif_clear_ip4_addr_conflict( fnet_netif_desc_t netif_desc );

 

 #if (FNET_CFG_MULTICAST & FNET_CFG_IP4) || defined(__DOXYGEN__)

 

 /***************************************************************************/

 void fnet_netif_join_ip4_multicast ( fnet_netif_desc_t netif_desc, fnet_ip4_addr_t multicast_addr );

 

 /***************************************************************************/

 void fnet_netif_leave_ip4_multicast ( fnet_netif_desc_t netif_desc, fnet_ip4_addr_t multicast_addr );

 

 #endif /* FNET_CFG_MULTICAST & FNET_CFG_IP4*/

 

 #if FNET_CFG_IP6 || defined(__DOXYGEN__)

 

 /***************************************************************************/

 void fnet_netif_join_ip6_multicast ( fnet_netif_desc_t netif_desc, const fnet_ip6_addr_t *multicast_addr );

 

 /***************************************************************************/

 void fnet_netif_leave_ip6_multicast ( fnet_netif_desc_t netif_desc, fnet_ip6_addr_t *multicast_addr );

 

 /***************************************************************************/

 fnet_bool_t fnet_netif_get_ip6_addr ( fnet_netif_desc_t netif_desc, fnet_index_t n, fnet_netif_ip6_addr_info_t *addr_info );

 

 #if FNET_CFG_DNS || defined(__DOXYGEN__)

 /***************************************************************************/

 fnet_bool_t fnet_netif_get_ip6_dns( fnet_netif_desc_t netif_desc, fnet_index_t n, fnet_ip6_addr_t *addr_dns );

 #endif /* FNET_CFG_DNS */

 

 /***************************************************************************/

 fnet_return_t fnet_netif_bind_ip6_addr(fnet_netif_desc_t netif_desc, const fnet_ip6_addr_t *addr, fnet_netif_ip_addr_type_t addr_type);

 

 /***************************************************************************/

 fnet_return_t fnet_netif_unbind_ip6_addr(fnet_netif_desc_t netif_desc, const fnet_ip6_addr_t *addr);

 

 /***************************************************************************/

 fnet_bool_t fnet_netif_get_ip6_prefix( fnet_netif_desc_t netif_desc, fnet_index_t n, fnet_netif_ip6_prefix_t *ip6_prefix);

 

 /***************************************************************************/

 fnet_bool_t fnet_netif_get_ip6_neighbor_cache(fnet_netif_desc_t netif_desc, fnet_index_t n, fnet_netif_ip6_neighbor_cache_t *ip6_neighbor_cache );

 

 #endif /* FNET_CFG_IP6 */

 

 /***************************************************************************/

 fnet_scope_id_t fnet_netif_get_scope_id(fnet_netif_desc_t netif_desc);

 

 /***************************************************************************/

 fnet_size_t fnet_netif_get_mtu(fnet_netif_desc_t netif_desc);

 

 /***************************************************************************/

 fnet_netif_desc_t fnet_netif_get_by_scope_id(fnet_scope_id_t scope_id);

 

 /***************************************************************************/

 fnet_netif_desc_t fnet_netif_get_by_sockaddr( const struct fnet_sockaddr *addr );

 

 /***************************************************************************/

 fnet_return_t fnet_netif_init(fnet_netif_desc_t netif_desc, fnet_uint8_t *hw_addr, fnet_size_t hw_addr_size );

 

 /***************************************************************************/

 void fnet_netif_release(fnet_netif_desc_t netif_desc);

 

 /***************************************************************************/

 fnet_bool_t fnet_netif_is_initialized(fnet_netif_desc_t netif_desc);

 

 #if defined(__cplusplus)

 }

 #endif

 

 #endif /* _FNET_NETIF_H_ */