processIE.h

Go to the documentation of this file.

#ifndef __PROCESSIE_H
#define __PROCESSIE_H

#include "openwsn.h"

//=========================== define ==========================================

// maximum of cells in a Schedule IE
#define SCHEDULEIEMAXNUMCELLS 3

// subIE shift
#define MLME_IE_SUBID_SHIFT            1

// subIEs identifier
#define MLME_IE_SUBID_CHANNELHOPPING   0x09
#define MLME_IE_SUBID_SYNC             0x1A
#define MLME_IE_SUBID_SLOTFRAME_LINK   0x1B
#define MLME_IE_SUBID_TIMESLOT         0x1c
#define MLME_IE_SUBID_LINKTYPE         0x40
#define MLME_IE_SUBID_OPCODE           0x41
#define MLME_IE_SUBID_BANDWIDTH        0x42
#define MLME_IE_SUBID_TRACKID          0x43
#define MLME_IE_SUBID_SCHEDULE         0x44

// ========================== typedef =========================================

BEGIN_PACK

typedef struct {
   uint16_t        tsNum;
   uint16_t        choffset;
   uint8_t         linkoptions;
} cellInfo_ht;


typedef struct{
   uint16_t length_elementid_type; 
} header_IE_ht; 

typedef struct{
   uint16_t length_groupid_type;
} payload_IE_ht;

//======= header IEs

typedef struct {
   int16_t        timesync_info;
} timecorrection_IE_ht;

//======= payload IEs

typedef struct{
   uint16_t        length_subID_type;
} mlme_IE_ht;

typedef struct {
   uint8_t         asn[5];
   uint8_t         join_priority;
} sync_IE_ht;

typedef struct {
   uint8_t         slotframehandle;
   uint16_t        slotframesize;
   uint8_t         numlinks;
} slotframeLink_IE_ht;

typedef struct {
   uint8_t         opcode;
} opcode_IE_ht;

typedef struct{
   uint8_t         slotframeID;
   uint8_t         numOfLinks;
} bandwidth_IE_ht;

typedef struct{
   uint8_t         type;
   uint8_t         length;
   uint8_t         frameID;
   uint8_t         numberOfcells;
   bool            flag;
   cellInfo_ht     cellList[SCHEDULEIEMAXNUMCELLS];
} schedule_IE_ht;

END_PACK

//=========================== variables =======================================

//=========================== prototypes ======================================

void             processIE_prependMLMEIE(
   OpenQueueEntry_t*    pkt,
   uint8_t              len
);

//===== prepend IEs

uint8_t          processIE_prependSyncIE(
   OpenQueueEntry_t*    pkt
);
uint8_t          processIE_prependSlotframeLinkIE(
   OpenQueueEntry_t*    pkt
);
uint8_t          processIE_prependOpcodeIE(
   OpenQueueEntry_t*    pkt,
   uint8_t              uResCommandID
);
uint8_t          processIE_prependBandwidthIE(
   OpenQueueEntry_t*    pkt,
   uint8_t              numOfLinks, 
   uint8_t              slotframeID
);
uint8_t          processIE_prependSheduleIE(
   OpenQueueEntry_t*    pkt,
   uint8_t              type,
   uint8_t              frameID,
   uint8_t              flag,
   cellInfo_ht*         cellList
);

//===== retrieve IEs

void             processIE_retrieveSlotframeLinkIE(
   OpenQueueEntry_t*    pkt,
   uint8_t * ptr
); 
void             processIE_retrieveOpcodeIE(
   OpenQueueEntry_t*    pkt,
   uint8_t*             ptr,
   opcode_IE_ht*        opcodeIE
); 
void             processIE_retrieveBandwidthIE(
   OpenQueueEntry_t*    pkt,
   uint8_t *            ptr,
   bandwidth_IE_ht*     bandwidthIE
); 
void             processIE_retrieveSheduleIE(
   OpenQueueEntry_t*    pkt,
   uint8_t *            ptr,
   schedule_IE_ht*      schedule_ie
);

#endif