/*
 * Copyright (C) 2013  INRIA.
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @defgroup    net_ieee802154 IEEE802.15.4
 * @ingroup net
 * @brief   IEEE802.15.4 adapaption layer
 * @{
 *
 * @file
 * @brief   IEEE 802.14.4 framing data structs and prototypes
 *
 * @author  Stephan Zeisberg <zeisberg@mi.fu-berlin.de>
 * @author  Oliver Hahm <oliver.hahm@inria.fr>
 */

#ifndef IEEE802154_IEEE802154_FRAME
#define IEEE802154_IEEE802154_FRAME

#include <stdio.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

/* maximum 802.15.4 header length */
#define IEEE_802154_MAX_HDR_LEN         (23)
/* ...and FCS*/
#define IEEE_802154_FCS_LEN             (2)

typedef enum __attribute__((packed)) {
    IEEE_802154_BEACON_FRAME    = 0,
    IEEE_802154_DATA_FRAME      = 1,
    IEEE_802154_ACK_FRAME       = 2,
    IEEE_802154_MAC_CMD_FRAME   = 3
} ieee802154_frame_type_t;

#define IEEE_802154_SHORT_ADDR_M        (2)
#define IEEE_802154_LONG_ADDR_M         (3)

#define IEEE_802154_SHORT_MCAST_ADDR    (0xffff)
#define IEEE_802154_LONG_MCAST_ADDR     {{0xff, 0xff, 0xff, 0xff, 0xff, 0xff, \
                                          0xff, 0xff}}

/**
 * @brief The default PAN id to use if not specified otherwise by upper layers
 */
#define IEEE_802154_DEFAULT_PAN_ID      (1)

/**
 * @brief   Transform 16-bit number from network order (big-endian) to
 *          little-endian byte order (as used by IEEE 802.15.4).
 */
#define NTOLES(a)   (((a) >> 8) | (((a) & 0x00ff) << 8))

/**
 * @brief   Transform 16-bit number from little-endian byte order to network
 *          order (big-endian).
 */
#define LETONS(a)   NTOLES(a)

/**
 * @brief   Transform 16-bit number from host byte order to little-endian byte
 *          order (as used by IEEE 802.15.4).
 */
#define HTOLES(a)   a

/**
 * @brief   Transform 16-bit number from little-endian byte order to host byte
 *          order.
 */
#define LETOHS(a)   HTOLES(a)

typedef struct __attribute__((packed)) {
    ieee802154_frame_type_t frame_type;
    uint8_t sec_enb;
    uint8_t frame_pend;
    uint8_t ack_req;
    uint8_t panid_comp;
    uint8_t dest_addr_m;
    uint8_t frame_ver;
    uint8_t src_addr_m;
} ieee802154_frame_fcf_frame_t;

typedef struct __attribute__((packed)) {
    ieee802154_frame_fcf_frame_t fcf;
    uint8_t seq_nr;
    uint16_t dest_pan_id;
    uint8_t dest_addr[8];
    uint16_t src_pan_id;
    uint8_t src_addr[8];
    uint8_t *payload;
    uint8_t payload_len;
} ieee802154_frame_t;

/**
 * Structure to represent an IEEE 802.15.4 packet for the transceiver.
 */
typedef struct __attribute__(( packed )) {
    /* @{ */
    uint8_t processing;         /** < internal processing state */
    uint8_t length;             /** < the length of the frame of the frame including fcs*/
    ieee802154_frame_t frame;   /** < the ieee802154 frame */
    int8_t rssi;                /** < the rssi value */
    uint8_t crc;                /** < 1 if crc was successfull, 0 otherwise */
    uint8_t lqi;                /** < the link quality indicator */
    /* @} */
} ieee802154_packet_t;

uint8_t ieee802154_frame_init(ieee802154_frame_t *frame, uint8_t *buf);
uint8_t ieee802154_frame_get_hdr_len(ieee802154_frame_t *frame);
uint8_t ieee802154_frame_read(uint8_t *buf, ieee802154_frame_t *frame, uint8_t len);
void ieee802154_frame_print_fcf_frame(ieee802154_frame_t *frame);
uint16_t ieee802154_frame_get_fcs(const uint8_t *frame, uint8_t frame_len);

#ifdef __cplusplus
}
#endif

/** @} */
#endif /* IEEE802154_IEEE802154_FRAME */