asuswrt-merlin.ng/release/src-rt-5.02axhnd.675x/bcmdrivers/opensource/include/bcm963xx/spdt_defs.h

/*
<:copyright-BRCM:2018:DUAL/GPL:standard

   Copyright (c) 2018 Broadcom 
   All Rights Reserved

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 2, as published by
the Free Software Foundation (the "GPL").

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.


A copy of the GPL is available at http://www.broadcom.com/licenses/GPLv2.php, or by
writing to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.

:>
*/

#ifndef __SPDT_DEFS_H__
#define __SPDT_DEFS_H__

#include <linux/socket.h>
#include <linux/types.h>

/********* Definitons and Data Structures **************/

#define SPDT_NUM_OF_STREAMS           4
#define SPDT_OTHER_STAT_MAX_LEN       256

/*< Generic data structures to open connections (streams) */

/*< Supported applications and protocols */
typedef enum
{
    SPDT_NONE,
    SPDT_HTTP,
    SPDT_FTP,
    SPDT_TCP_BASIC = SPDT_FTP, /*< Basic TCP data */
    SPDT_IPERF3_TCP,
    SPDT_UDP_BASIC, /*< Basic UDP data */
    SPDT_IPERF3_UDP, /* Not supported yet, placeholder for future support */
    SPDT_MAX,
} spdt_proto_t;

/*< Connection parameters for each stream (=socket) */
typedef struct
{
    struct sockaddr_storage server_addr;
    struct sockaddr_storage local_addr;
    uint8_t tos;
} __attribute__ ((packed)) spdt_conn_params_t;


/*< Data structures to start/stop the speed tests on the opened connections */

/*< Transmit parameters */
typedef struct
{
    union {

        struct {
            uint64_t size;
        } tcp;

        struct {
            uint32_t kbps; /*< Data rate */
            uint32_t data_buf_len; /*< UDP packet payload; PPS will be calculated from data rate and packet payload length. The length plus packet header should not exceed max MTU size. */
            uint32_t max_burst_size; /*< Optional, can be 0 */

            void *data_buf; /*< Data buffer to be transmitted. If not set, emtpy data buffer will be allocated according to data_buf_len */
            uint64_t total_bytes_to_send; /*< Total number of bytes to be sent. Optional, when not set, trasmit should be stopped explicitly */
            uint8_t iperf3_64bit_counters; /*< Iperf3 configuration: use 64-bit counters in UDP test packets */
        } udp;
    } proto;
} __attribute__ ((packed)) spdt_tx_params_t;


/*< Receive parameters */
typedef struct
{
    union {

        struct {
            uint64_t size;
            char *file_name; /* For http GET request */
            char *host_name;
        } tcp;

        /* Currently not in use for UDP */
    } proto;
} __attribute__ ((packed)) spdt_rx_params_t;



/*< Definitions and Data structures collect speed tests statistics */

/*< TR-143 timestamp reports */
typedef enum
{
    SPDT_TR143_TS_REPORT_ROM_TIME,
    SPDT_TR143_TS_REPORT_BOM_TIME,
    SPDT_TR143_TS_REPORT_EOM_TIME,
    SPDT_TR143_TS_REPORT_MAX
} spdt_tr143_timestamp_report_t;

/*< Time report */
typedef struct
{
    uint32_t tv_sec;
    uint32_t tv_usec;
} __attribute__ ((packed)) tcp_spdt_time_rep_t;

/*< TCP Speed report */
typedef struct
{
    uint32_t rate;
    uint64_t num_bytes;
    uint64_t expected_bytes;
    uint32_t time_ms;
    union
    {
        tcp_spdt_time_rep_t tr143_ts[SPDT_TR143_TS_REPORT_MAX];
        char                other[SPDT_OTHER_STAT_MAX_LEN];
    } msg;
    int32_t status;
} __attribute__ ((packed)) tcp_spdt_rep_t; 

/* Iperf3 UDP statistics. Not supported yet, placeholder for future usage */
typedef struct
{
    struct {
        uint64_t packets;
        uint64_t bytes;
    } rx;
    struct {
        uint64_t packets;
        uint64_t bytes;
    } tx;
    uint64_t out_of_order_pkts;
    uint64_t error_cnt_pkts;
    uint32_t jitter;
} __attribute__ ((packed)) udp_spdt_iperf3_stat_t;

typedef struct
{
    struct {
        uint64_t packets; 
        uint64_t bytes; 
    } rx;
    struct {
        uint64_t packets;
        uint64_t bytes; 
    } tx;
    uint64_t rx_usec;
    uint64_t tx_usec;
} __attribute__ ((packed)) udp_spdt_basic_stat_t;

typedef struct
{
    union
    {
        udp_spdt_basic_stat_t udp_basic; 
        udp_spdt_iperf3_stat_t udp_iperf3; /* Not supported yet, placeholder for future usage */
        tcp_spdt_rep_t tcp_speed_rep;
    } proto_ext;
} __attribute__ ((packed)) spdt_stat_t;

typedef enum
{
    SPDT_DIR_NONE,
    SPDT_DIR_TX,
    SPDT_DIR_RX
} spdt_stream_dir_t;

typedef struct
{
    spdt_proto_t protocol;
    spdt_conn_params_t conn_params;
    int sock_fd;
    int is_v6;
    spdt_stream_dir_t dir;
    uint32_t tx_data_buf_len; /* Data buffer length for TX, used to calculate UDP statistics */
} __attribute__ ((packed)) spdt_stream_params_t;

#endif /* __SPDT_DEFS_H__ */