types.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008-2012 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
 * =======================================================================
 */

#ifndef __WPAN_TYPES_H
#define __WPAN_TYPES_H

#include "xbee/platform.h"

XBEE_BEGIN_DECLS

typedef union {
   uint8_t        b[8];
   uint16_t       u[4];
   uint32_t       l[2];
} addr64;


#ifndef ADDR64_FORMAT_SEPARATOR
   #define ADDR64_FORMAT_SEPARATOR '-'
#endif

#define ADDR64_STRING_LENGTH (8 * 2 + 7 + 1)

// These functions are documented with their implementation in wpan_types.c
char FAR *addr64_format( char FAR *buffer, const addr64 FAR *address);
bool_t addr64_equal( const addr64 FAR *addr1, const addr64 FAR *addr2);
bool_t addr64_is_zero( const addr64 FAR *addr);
int addr64_parse( addr64 *address, const char FAR *str);

#define WPAN_NET_ADDR_BCAST_ALL_NODES  0xFFFF
#define WPAN_NET_ADDR_BCAST_NOT_ASLEEP 0xFFFD
#define WPAN_NET_ADDR_BCAST_ROUTERS    0xFFFC

#define WPAN_NET_ADDR_UNDEFINED        0xFFFE

#define WPAN_NET_ADDR_COORDINATOR      0x0000

#define WPAN_IEEE_ADDR_UNDEFINED (&_WPAN_IEEE_ADDR_UNDEFINED)
extern const addr64 _WPAN_IEEE_ADDR_UNDEFINED;

#define WPAN_IEEE_ADDR_BROADCAST (&_WPAN_IEEE_ADDR_BROADCAST)
extern const addr64 _WPAN_IEEE_ADDR_BROADCAST;

#define WPAN_IEEE_ADDR_COORDINATOR (&_WPAN_IEEE_ADDR_COORDINATOR)
extern const addr64 _WPAN_IEEE_ADDR_COORDINATOR;

#define WPAN_IEEE_ADDR_ALL_ZEROS (&_WPAN_IEEE_ADDR_COORDINATOR)

typedef struct _wpan_address_t {
   addr64      ieee;
   uint16_t    network;
} wpan_address_t;

XBEE_END_DECLS

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

#endif // #ifdef __WPAN_TYPES_H