source: ReferenceDesigns/w3_802.11/c/wlan_mac_high_framework/include/wlan_mac_ltg.h

/** @file wlan_mac_ltg.h
 *  @brief Local Traffic Generator
 *
 *  This contains code for scheduling local traffic directly from the
 *  board.
 *
 *  @copyright Copyright 2013-2019, Mango Communications. All rights reserved.
 *          Distributed under the Mango Communications Reference Design License
 *              See LICENSE.txt included in the design archive or
 *              at http://mangocomm.com/802.11/license
 *
 *  This file is part of the Mango 802.11 Reference Design (https://mangocomm.com/802.11)
 */

#ifndef WLAN_MAC_LTG_H_
#define WLAN_MAC_LTG_H_

#include "wlan_mac_high_sw_config.h"
#include "xil_types.h"
#include "wlan_common_types.h"

//Forward declarations
struct mac_header_80211_common;

//LTG Schedules define the times when LTG event callbacks are called.
#define LTG_SCHED_TYPE_PERIODIC         1
#define LTG_SCHED_TYPE_UNIFORM_RAND     2

//LTG Payloads define how payloads are constructed once the LTG event callbacks
//are called. For example, the LTG_SCHED_TYPE_PERIODIC schedule that employs the
//LTG_PYLD_TYPE_FIXED would result in a constant bit rate (CBR) traffic
//profile
#define LTG_PYLD_TYPE_FIXED             1
#define LTG_PYLD_TYPE_UNIFORM_RAND      2
#define LTG_PYLD_TYPE_ALL_ASSOC_FIXED   3
#define LTG_PYLD_TYPE_CTRL_RESP         4

#define LTG_REMOVE_ALL                  0xFFFFFFFF
#define LTG_START_ALL                   0xFFFFFFFF
#define LTG_STOP_ALL                    0xFFFFFFFF

//In spirit, tg_schedule is derived from dl_entry. Since C
//lacks a formal notion of inheritance, we adopt a popular
//alternative idiom for inheritance where the dl_entry
//is the first entry in the new structure. Since structures
//will never be padded before their first entry, it is safe
//to cast back and forth between the tg_schedule and dl_entry.
typedef struct tg_schedule tg_schedule;
struct tg_schedule{
    u32 id;
    u32 type;
    u64 target;
    u64 stop_target;
    void* params;
    void* callback_arg;
    function_ptr_t cleanup_callback;
    void* state;
};

//LTG Schedules

#define LTG_DURATION_FOREVER 0

typedef struct ltg_sched_state_hdr{
    u8  enabled;
    u8  reserved[3];
    u64 start_timestamp;
    u64 stop_timestamp;
} ltg_sched_state_hdr_t;

typedef struct ltg_sched_periodic_params{
    u32 interval_count;
    u64 duration_count;
} ltg_sched_periodic_params_t;

typedef struct ltg_sched_periodic_state{
    ltg_sched_state_hdr_t hdr;
    u32 time_to_next_count;
} ltg_sched_periodic_state_t;

// Note: count variables are in units of FAST_TIMER_DUR_US
typedef struct ltg_sched_uniform_rand_params{
    u32 min_interval_count;
    u32 max_interval_count;
    u64 duration_count;
} ltg_sched_uniform_rand_params_t;

typedef struct ltg_sched_uniform_rand_state{
    ltg_sched_state_hdr_t hdr;
    u32 time_to_next_count;
} ltg_sched_uniform_rand_state_t;

//LTG Payload Profiles

typedef struct ltg_pyld_hdr{
    u32 type;
} ltg_pyld_hdr_t;

typedef struct ltg_pyld_fixed{
    ltg_pyld_hdr_t hdr;
    u8  addr_da[MAC_ADDR_LEN];
    u16 length;
} __attribute__((__packed__)) ltg_pyld_fixed_t;
ASSERT_TYPE_SIZE(ltg_pyld_fixed_t, 12);

#define LTG_PYLD_CTRL_RESP_SUBTYPE_CTS 0
#define LTG_PYLD_CTRL_RESP_SUBTYPE_ACK 1

typedef struct ltg_pyld_ctrl_resp_t{
    ltg_pyld_hdr_t hdr;
    u8  addr_ra[MAC_ADDR_LEN];
    u16 subtype;
    u16 duration;
} __attribute__((__packed__)) ltg_pyld_ctrl_resp_t;
ASSERT_TYPE_SIZE(ltg_pyld_ctrl_resp_t, 14);

typedef struct ltg_pyld_all_assoc_fixed_t{
    ltg_pyld_hdr_t hdr;
    u16 length;
} __attribute__((__packed__)) ltg_pyld_all_assoc_fixed_t;
ASSERT_TYPE_SIZE(ltg_pyld_all_assoc_fixed_t, 6);

typedef struct ltg_pyld_uniform_rand_t{
    ltg_pyld_hdr_t hdr;
    u8  addr_da[MAC_ADDR_LEN];
    u16 min_length;
    u16 max_length;
} __attribute__((__packed__)) ltg_pyld_uniform_rand_t;
ASSERT_TYPE_SIZE(ltg_pyld_uniform_rand_t, 14);


//Note: This definition simply reflects the use of the fast timer for LTG polling. To increase LTG
//polling rate at the cost of more overhead in checking LTGs, increase the speed of the fast timer.
#define LTG_ID_INVALID                 0xFFFFFFFF

//External function to LTG -- user code interacts with the LTG via these functions
int wlan_mac_ltg_sched_init();
void wlan_mac_ltg_sched_set_callback(void(*callback)());
u32 ltg_sched_create(u32 type, void* params, void* callback_arg, void(*callback)());
int ltg_sched_remove(u32 id);
int ltg_sched_remove_all();
int ltg_sched_start(u32 id);
int ltg_sched_start_all();
int ltg_sched_stop(u32 id);
int ltg_sched_stop_all();
int ltg_sched_get_state(u32 id, u32* type, void** state);
int ltg_sched_get_params(u32 id, void** params);
int ltg_sched_get_callback_arg(u32 id, void** callback_arg);

int wlan_create_ltg_frame(u8* pkt,
                          u8* addr1,
                          u8* addr2,
                          u8* addr3,
                          u8 frame_control_2,
                          u32 ltg_id);

dl_entry* ltg_sched_find_tg_schedule(u32 id);

#endif /* WLAN_MAC_LTG_H_ */