ipv4.h

Go to the documentation of this file.

/*
 * Copyright (c) 2017 Digi International Inc.,
 * All rights not expressly granted are reserved.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
 * =======================================================================
 */

/*
   Dev notes:

   Consider this a starting point.  I think we could develop something
   based on the wpan/aps.h APIs for using "envelope" structures to
   route frames.  Implementing Berkeley sockets is going to take a bit
   of work (and buffering), but keeping tables for open and listening
   sockets with handlers to receive ipv4_envelope_t structures should
   work well for typical use cases.
*/

#ifndef XBEE_IPV4_H
#define XBEE_IPV4_H

#include "xbee/platform.h"
#include "xbee/device.h"

#if (!XBEE_WIFI_ENABLED) && (!XBEE_CELLULAR_ENABLED)
   #error "At least one of XBEE_WIFI_ENABLED and XBEE_CELLULAR_ENABLED " \
      "must be defined as non-zero to use this header."
#endif

XBEE_BEGIN_DECLS

#define XBEE_FRAME_TRANSMIT_IPV4       0x20

#define XBEE_FRAME_RECEIVE_IPV4        0xB0

#define XBEE_IPV4_PROTOCOL_UDP         0        
#define XBEE_IPV4_PROTOCOL_TCP         1        
#define XBEE_IPV4_PROTOCOL_SSL         4        


#define XBEE_IPV4_TX_OPT_NONE          0        
#define XBEE_IPV4_TX_OPT_TCP_CLOSE     (1<<1)   

#define XBEE_IPV4_MAX_PAYLOAD          1500

typedef XBEE_PACKED(xbee_header_transmit_ipv4_t, {
   uint8_t        frame_type;          
   uint8_t        frame_id;
   uint32_t       remote_addr_be;
   uint16_t       remote_port_be;
   uint16_t       local_port_be;
   uint8_t        protocol;            
   uint8_t        options;             
}) xbee_header_transmit_ipv4_t;

typedef XBEE_PACKED(xbee_frame_receive_ipv4_t, {
   uint8_t        frame_type;          
   uint32_t       remote_addr_be;
   uint16_t       local_port_be;
   uint16_t       remote_port_be;
   uint8_t        protocol;            
   uint8_t        status;
   uint8_t        payload[1];          
}) xbee_frame_receive_ipv4_t;

/*
   Dev notes:
   - We'll keep remote address in big-endian format, since it's easier to
     always deal with it that way, and we always used 64-bit IEEE addresses
     on 802.15.4 networks in big-endian byte order.
   - Easy to reply to a message, just copy the start of the envelope.
     (offsetof(ipv4_envelope_t, options) bytes)

   For docs:
   @sa xbee_ipv4_ntoa(), xbee_ipv4_protocol_str()
*/
/* Similar concept to wpan_envelope_t, needs some more documentation. */
typedef struct xbee_ipv4_envelope_t {
   // first group of members are common when creating reply envelope
   xbee_dev_t *xbee;                   
   uint32_t remote_addr_be;            
   uint16_t local_port;                
   uint16_t remote_port;               
   uint8_t protocol;                   

   // second group of members are modified when creating reply envelope
   uint16_t options;
   const void FAR *payload;            
   uint16_t length;                    
} xbee_ipv4_envelope_t;


int xbee_ipv4_envelope_reply(xbee_ipv4_envelope_t FAR *reply,
   const xbee_ipv4_envelope_t FAR *original);


void xbee_ipv4_envelope_dump(const xbee_ipv4_envelope_t FAR *envelope,
   bool_t include_payload);


int xbee_ipv4_envelope_send(const xbee_ipv4_envelope_t FAR *envelope);

int xbee_ipv4_receive_dump(xbee_dev_t *xbee, const void FAR *raw,
   uint16_t length, void FAR *context);

int xbee_ipv4_ntoa(char buffer[16], uint32_t ip_be);

int xbee_ipv4_aton(const char * cp, uint32_t *ip_be);

char *xbee_ipv4_protocol_str(char buffer[8], uint8_t protocol);

XBEE_END_DECLS

// If compiling in Dynamic C, automatically #use the appropriate C file.
#ifdef __DC__
   #use "xbee_sms.c"
#endif

#endif