[GitHub/LineageOS/G12/android_hardware_amlogic_kernel-modules_dhd-driver.git] / bcmdhd.100.10.545.x / include / dhdioctl.h

/*
 * Definitions for ioctls to access DHD iovars.
 * Based on wlioctl.h (for Broadcom 802.11abg driver).
 * (Moves towards generic ioctls for BCM drivers/iovars.)
 *
 * Definitions subject to change without notice.
 *
 * Copyright (C) 1999-2019, Broadcom.
 *
 *      Unless you and Broadcom execute a separate written software license
 * agreement governing use of this software, this software is licensed to you
 * under the terms of the GNU General Public License version 2 (the "GPL"),
 * available at http://www.broadcom.com/licenses/GPLv2.php, with the
 * following added to such license:
 *
 *      As a special exception, the copyright holders of this software give you
 * permission to link this software with independent modules, and to copy and
 * distribute the resulting executable under terms of your choice, provided that
 * you also meet, for each linked independent module, the terms and conditions of
 * the license of that module.  An independent module is a module which is not
 * derived from this software.  The special exception does not apply to any
 * modifications of the software.
 *
 *      Notwithstanding the above, under no circumstances may you combine this
 * software in any way with any other Broadcom software provided under a license
 * other than the GPL, without Broadcom's express prior written consent.
 *
 *
 * <<Broadcom-WL-IPTag/Open:>>
 *
 * $Id: dhdioctl.h 800512 2019-01-22 09:31:01Z $
 */

#ifndef _dhdioctl_h_
#define	_dhdioctl_h_

#include <typedefs.h>

/* Linux network driver ioctl encoding */
typedef struct dhd_ioctl {
	uint32 cmd;	/* common ioctl definition */
	void *buf;	/* pointer to user buffer */
	uint32 len;	/* length of user buffer */
	uint32 set;	/* get or set request boolean (optional) */
	uint32 used;	/* bytes read or written (optional) */
	uint32 needed;	/* bytes needed (optional) */
	uint32 driver;	/* to identify target driver */
} dhd_ioctl_t;

/* Underlying BUS definition */
enum {
	BUS_TYPE_USB = 0, /* for USB dongles */
	BUS_TYPE_SDIO, /* for SDIO dongles */
	BUS_TYPE_PCIE /* for PCIE dongles */
};

typedef enum {
	DMA_XFER_SUCCESS = 0,
	DMA_XFER_IN_PROGRESS,
	DMA_XFER_FAILED
} dma_xfer_status_t;

typedef enum d11_lpbk_type {
	M2M_DMA_LPBK = 0,
	D11_LPBK = 1,
	BMC_LPBK = 2,
	M2M_NON_DMA_LPBK = 3,
	D11_HOST_MEM_LPBK = 4,
	BMC_HOST_MEM_LPBK = 5,
	MAX_LPBK = 6
} dma_xfer_type_t;

typedef struct dmaxfer_info {
	uint16 version;
	uint16 length;
	dma_xfer_status_t status;
	dma_xfer_type_t type;
	uint src_delay;
	uint dest_delay;
	uint should_wait;
	uint core_num;
	int error_code;
	uint32 num_bytes;
	uint64 time_taken;
	uint64 tput;
} dma_xfer_info_t;

#define DHD_DMAXFER_VERSION 0x1

typedef struct tput_test {
	uint16 version;
	uint16 length;
	uint8 direction;
	uint8 tput_test_running;
	uint8 mac_sta[6];
	uint8 mac_ap[6];
	uint8 PAD[2];
	uint32 payload_size;
	uint32 num_pkts;
	uint32 timeout_ms;
	uint32 flags;

	uint32 pkts_good;
	uint32 pkts_bad;
	uint32 pkts_cmpl;
	uint64 time_ms;
	uint64 tput_bps;
} tput_test_t;

typedef enum {
	TPUT_DIR_TX = 0,
	TPUT_DIR_RX
} tput_dir_t;

#define TPUT_TEST_T_VER 1
#define TPUT_TEST_T_LEN 68
#define TPUT_TEST_MIN_PAYLOAD_SIZE 16
#define TPUT_TEST_USE_ETHERNET_HDR 0x1
#define TPUT_TEST_USE_802_11_HDR 0x2

/* per-driver magic numbers */
#define DHD_IOCTL_MAGIC		0x00444944

/* bump this number if you change the ioctl interface */
#define DHD_IOCTL_VERSION	1

/*
 * Increase the DHD_IOCTL_MAXLEN to 16K for supporting download of NVRAM files of size
 * > 8K. In the existing implementation when NVRAM is to be downloaded via the "vars"
 * DHD IOVAR, the NVRAM is copied to the DHD Driver memory. Later on when "dwnldstate" is
 * invoked with FALSE option, the NVRAM gets copied from the DHD driver to the Dongle
 * memory. The simple way to support this feature without modifying the DHD application,
 * driver logic is to increase the DHD_IOCTL_MAXLEN size. This macro defines the "size"
 * of the buffer in which data is exchanged between the DHD App and DHD driver.
 */
#define	DHD_IOCTL_MAXLEN	(16384)	/* max length ioctl buffer required */
#define	DHD_IOCTL_SMLEN		256		/* "small" length ioctl buffer required */

/* common ioctl definitions */
#define DHD_GET_MAGIC				0
#define DHD_GET_VERSION				1
#define DHD_GET_VAR				2
#define DHD_SET_VAR				3

/* message levels */
#define DHD_ERROR_VAL	0x0001
#define DHD_TRACE_VAL	0x0002
#define DHD_INFO_VAL	0x0004
#define DHD_DATA_VAL	0x0008
#define DHD_CTL_VAL	0x0010
#define DHD_TIMER_VAL	0x0020
#define DHD_HDRS_VAL	0x0040
#define DHD_BYTES_VAL	0x0080
#define DHD_INTR_VAL	0x0100
#define DHD_LOG_VAL	0x0200
#define DHD_GLOM_VAL	0x0400
#define DHD_EVENT_VAL	0x0800
#define DHD_BTA_VAL	0x1000
#define DHD_ISCAN_VAL	0x2000
#define DHD_ARPOE_VAL	0x4000
#define DHD_REORDER_VAL	0x8000
#define DHD_NOCHECKDIED_VAL		0x20000 /* UTF WAR */
#define DHD_PNO_VAL		0x80000
#define DHD_RTT_VAL		0x100000
#define DHD_MSGTRACE_VAL	0x200000
#define DHD_FWLOG_VAL		0x400000
#define DHD_DBGIF_VAL		0x800000
#ifdef DHD_PCIE_NATIVE_RUNTIMEPM
#define DHD_RPM_VAL		0x1000000
#endif /* DHD_PCIE_NATIVE_RUNTIMEPM */
#define DHD_PKT_MON_VAL		0x2000000
#define DHD_PKT_MON_DUMP_VAL	0x4000000
#define DHD_ERROR_MEM_VAL	0x8000000
#define DHD_DNGL_IOVAR_SET_VAL	0x10000000 /**< logs the setting of dongle iovars */
#define DHD_LPBKDTDUMP_VAL	0x20000000
#define DHD_PRSRV_MEM_VAL	0x40000000
#define DHD_IOVAR_MEM_VAL	0x80000000
#define DHD_ANDROID_VAL	0x10000
#define DHD_IW_VAL	0x20000
#define DHD_CFG_VAL	0x40000
#define DHD_CONFIG_VAL	0x80000
#define DUMP_EAPOL_VAL	0x0001
#define DUMP_ARP_VAL	0x0002
#define DUMP_DHCP_VAL	0x0004
#define DUMP_ICMP_VAL	0x0008
#define DUMP_DNS_VAL	0x0010
#define DUMP_TRX_VAL	0x0080

#ifdef SDTEST
/* For pktgen iovar */
typedef struct dhd_pktgen {
	uint32 version;		/* To allow structure change tracking */
	uint32 freq;		/* Max ticks between tx/rx attempts */
	uint32 count;		/* Test packets to send/rcv each attempt */
	uint32 print;		/* Print counts every <print> attempts */
	uint32 total;		/* Total packets (or bursts) */
	uint32 minlen;		/* Minimum length of packets to send */
	uint32 maxlen;		/* Maximum length of packets to send */
	uint32 numsent;		/* Count of test packets sent */
	uint32 numrcvd;		/* Count of test packets received */
	uint32 numfail;		/* Count of test send failures */
	uint32 mode;		/* Test mode (type of test packets) */
	uint32 stop;		/* Stop after this many tx failures */
} dhd_pktgen_t;

/* Version in case structure changes */
#define DHD_PKTGEN_VERSION 2

/* Type of test packets to use */
#define DHD_PKTGEN_ECHO		1 /* Send echo requests */
#define DHD_PKTGEN_SEND 	2 /* Send discard packets */
#define DHD_PKTGEN_RXBURST	3 /* Request dongle send N packets */
#define DHD_PKTGEN_RECV		4 /* Continuous rx from continuous tx dongle */
#endif /* SDTEST */

/* Enter idle immediately (no timeout) */
#define DHD_IDLE_IMMEDIATE	(-1)

/* Values for idleclock iovar: other values are the sd_divisor to use when idle */
#define DHD_IDLE_ACTIVE	0	/* Do not request any SD clock change when idle */
#define DHD_IDLE_STOP   (-1)	/* Request SD clock be stopped (and use SD1 mode) */

enum dhd_maclist_xtlv_type {
	DHD_MACLIST_XTLV_R = 0x1,
	DHD_MACLIST_XTLV_X = 0x2,
	DHD_SVMPLIST_XTLV = 0x3
};

typedef struct _dhd_maclist_t {
	uint16 version;		/* Version */
	uint16 bytes_len;	/* Total bytes length of lists, XTLV headers and paddings */
	uint8 plist[1];		/* Pointer to the first list */
} dhd_maclist_t;

typedef struct _dhd_pd11regs_param {
	uint16 start_idx;
	uint8 verbose;
	uint8 pad;
	uint8 plist[1];
} dhd_pd11regs_param;

typedef struct _dhd_pd11regs_buf {
	uint16 idx;
	uint8 pad[2];
	uint8 pbuf[1];
} dhd_pd11regs_buf;

/* BT logging and memory dump */

#define BT_LOG_BUF_MAX_SIZE		(DHD_IOCTL_MAXLEN - (2 * sizeof(int)))
#define BT_LOG_BUF_NOT_AVAILABLE	0
#define BT_LOG_NEXT_BUF_NOT_AVAIL	1
#define BT_LOG_NEXT_BUF_AVAIL		2
#define BT_LOG_NOT_READY		3

typedef struct bt_log_buf_info {
	int availability;
	int size;
	char buf[BT_LOG_BUF_MAX_SIZE];
} bt_log_buf_info_t;

/* request BT memory in chunks */
typedef struct bt_mem_req {
	int offset;	/* offset from BT memory start */
	int buf_size;	/* buffer size per chunk */
} bt_mem_req_t;

/* max dest supported */
#define DEBUG_BUF_DEST_MAX	4

/* debug buf dest stat */
typedef struct debug_buf_dest_stat {
	uint32 stat[DEBUG_BUF_DEST_MAX];
} debug_buf_dest_stat_t;

#endif /* _dhdioctl_h_ */
Commit	Line	Data
d2839953 RC	1	/*
	2	* Definitions for ioctls to access DHD iovars.
	3	* Based on wlioctl.h (for Broadcom 802.11abg driver).
	4	* (Moves towards generic ioctls for BCM drivers/iovars.)
	5	*
	6	* Definitions subject to change without notice.
	7	*
965f77c4	8	* Copyright (C) 1999-2019, Broadcom.
d2839953 RC	9	*
	10	* Unless you and Broadcom execute a separate written software license
	11	* agreement governing use of this software, this software is licensed to you
	12	* under the terms of the GNU General Public License version 2 (the "GPL"),
	13	* available at http://www.broadcom.com/licenses/GPLv2.php, with the
	14	* following added to such license:
	15	*
	16	* As a special exception, the copyright holders of this software give you
	17	* permission to link this software with independent modules, and to copy and
	18	* distribute the resulting executable under terms of your choice, provided that
	19	* you also meet, for each linked independent module, the terms and conditions of
	20	* the license of that module. An independent module is a module which is not
	21	* derived from this software. The special exception does not apply to any
	22	* modifications of the software.
	23	*
	24	* Notwithstanding the above, under no circumstances may you combine this
	25	* software in any way with any other Broadcom software provided under a license
	26	* other than the GPL, without Broadcom's express prior written consent.
	27	*
	28	*
	29	* <<Broadcom-WL-IPTag/Open:>>
	30	*
965f77c4	31	* $Id: dhdioctl.h 800512 2019-01-22 09:31:01Z $
d2839953 RC	32	*/
	33
	34	#ifndef _dhdioctl_h_
	35	#define _dhdioctl_h_
	36
	37	#include <typedefs.h>
	38
	39	/* Linux network driver ioctl encoding */
	40	typedef struct dhd_ioctl {
	41	uint32 cmd; /* common ioctl definition */
	42	void buf; / pointer to user buffer */
	43	uint32 len; /* length of user buffer */
	44	uint32 set; /* get or set request boolean (optional) */
	45	uint32 used; /* bytes read or written (optional) */
	46	uint32 needed; /* bytes needed (optional) */
	47	uint32 driver; /* to identify target driver */
	48	} dhd_ioctl_t;
	49
	50	/* Underlying BUS definition */
	51	enum {
	52	BUS_TYPE_USB = 0, /* for USB dongles */
	53	BUS_TYPE_SDIO, /* for SDIO dongles */
	54	BUS_TYPE_PCIE /* for PCIE dongles */
	55	};
	56
	57	typedef enum {
	58	DMA_XFER_SUCCESS = 0,
	59	DMA_XFER_IN_PROGRESS,
	60	DMA_XFER_FAILED
	61	} dma_xfer_status_t;
	62
965f77c4 RC	63	typedef enum d11_lpbk_type {
	64	M2M_DMA_LPBK = 0,
	65	D11_LPBK = 1,
	66	BMC_LPBK = 2,
	67	M2M_NON_DMA_LPBK = 3,
	68	D11_HOST_MEM_LPBK = 4,
	69	BMC_HOST_MEM_LPBK = 5,
	70	MAX_LPBK = 6
	71	} dma_xfer_type_t;
	72
	73	typedef struct dmaxfer_info {
	74	uint16 version;
	75	uint16 length;
	76	dma_xfer_status_t status;
	77	dma_xfer_type_t type;
	78	uint src_delay;
	79	uint dest_delay;
	80	uint should_wait;
	81	uint core_num;
	82	int error_code;
	83	uint32 num_bytes;
	84	uint64 time_taken;
	85	uint64 tput;
	86	} dma_xfer_info_t;
	87
	88	#define DHD_DMAXFER_VERSION 0x1
	89
d2839953 RC	90	typedef struct tput_test {
	91	uint16 version;
	92	uint16 length;
	93	uint8 direction;
	94	uint8 tput_test_running;
	95	uint8 mac_sta[6];
	96	uint8 mac_ap[6];
	97	uint8 PAD[2];
	98	uint32 payload_size;
	99	uint32 num_pkts;
	100	uint32 timeout_ms;
	101	uint32 flags;
	102
	103	uint32 pkts_good;
	104	uint32 pkts_bad;
	105	uint32 pkts_cmpl;
	106	uint64 time_ms;
	107	uint64 tput_bps;
	108	} tput_test_t;
	109
	110	typedef enum {
	111	TPUT_DIR_TX = 0,
	112	TPUT_DIR_RX
	113	} tput_dir_t;
	114
	115	#define TPUT_TEST_T_VER 1
	116	#define TPUT_TEST_T_LEN 68
	117	#define TPUT_TEST_MIN_PAYLOAD_SIZE 16
	118	#define TPUT_TEST_USE_ETHERNET_HDR 0x1
	119	#define TPUT_TEST_USE_802_11_HDR 0x2
	120
	121	/* per-driver magic numbers */
	122	#define DHD_IOCTL_MAGIC 0x00444944
	123
	124	/* bump this number if you change the ioctl interface */
	125	#define DHD_IOCTL_VERSION 1
	126
	127	/*
	128	* Increase the DHD_IOCTL_MAXLEN to 16K for supporting download of NVRAM files of size
	129	* > 8K. In the existing implementation when NVRAM is to be downloaded via the "vars"
	130	* DHD IOVAR, the NVRAM is copied to the DHD Driver memory. Later on when "dwnldstate" is
	131	* invoked with FALSE option, the NVRAM gets copied from the DHD driver to the Dongle
	132	* memory. The simple way to support this feature without modifying the DHD application,
	133	* driver logic is to increase the DHD_IOCTL_MAXLEN size. This macro defines the "size"
	134	* of the buffer in which data is exchanged between the DHD App and DHD driver.
	135	*/
	136	#define DHD_IOCTL_MAXLEN (16384) /* max length ioctl buffer required */
	137	#define DHD_IOCTL_SMLEN 256 /* "small" length ioctl buffer required */
	138
	139	/* common ioctl definitions */
	140	#define DHD_GET_MAGIC 0
	141	#define DHD_GET_VERSION 1
	142	#define DHD_GET_VAR 2
	143	#define DHD_SET_VAR 3
	144
	145	/* message levels */
	146	#define DHD_ERROR_VAL 0x0001
	147	#define DHD_TRACE_VAL 0x0002
	148	#define DHD_INFO_VAL 0x0004
	149	#define DHD_DATA_VAL 0x0008
	150	#define DHD_CTL_VAL 0x0010
	151	#define DHD_TIMER_VAL 0x0020
	152	#define DHD_HDRS_VAL 0x0040
	153	#define DHD_BYTES_VAL 0x0080
154	#define DHD_INTR_VAL 0x0100
155	#define DHD_LOG_VAL 0x0200
156	#define DHD_GLOM_VAL 0x0400
157	#define DHD_EVENT_VAL 0x0800
158	#define DHD_BTA_VAL 0x1000
159	#define DHD_ISCAN_VAL 0x2000
160	#define DHD_ARPOE_VAL 0x4000
161	#define DHD_REORDER_VAL 0x8000
162	#define DHD_NOCHECKDIED_VAL 0x20000 /* UTF WAR */
163	#define DHD_PNO_VAL 0x80000
164	#define DHD_RTT_VAL 0x100000
165	#define DHD_MSGTRACE_VAL 0x200000
166	#define DHD_FWLOG_VAL 0x400000
167	#define DHD_DBGIF_VAL 0x800000
168	#ifdef DHD_PCIE_NATIVE_RUNTIMEPM
169	#define DHD_RPM_VAL 0x1000000
170	#endif /* DHD_PCIE_NATIVE_RUNTIMEPM */
171	#define DHD_PKT_MON_VAL 0x2000000
172	#define DHD_PKT_MON_DUMP_VAL 0x4000000
173	#define DHD_ERROR_MEM_VAL 0x8000000
174	#define DHD_DNGL_IOVAR_SET_VAL 0x10000000 /*< logs the setting of dongle iovars /
175	#define DHD_LPBKDTDUMP_VAL 0x20000000
176	#define DHD_PRSRV_MEM_VAL 0x40000000
177	#define DHD_IOVAR_MEM_VAL 0x80000000
178	#define DHD_ANDROID_VAL 0x10000
179	#define DHD_IW_VAL 0x20000
180	#define DHD_CFG_VAL 0x40000
181	#define DHD_CONFIG_VAL 0x80000
3910ce8e LJ	182	#define DUMP_EAPOL_VAL 0x0001
	183	#define DUMP_ARP_VAL 0x0002
	184	#define DUMP_DHCP_VAL 0x0004
	185	#define DUMP_ICMP_VAL 0x0008
	186	#define DUMP_DNS_VAL 0x0010
	187	#define DUMP_TRX_VAL 0x0080
d2839953 RC	188
	189	#ifdef SDTEST
	190	/* For pktgen iovar */
	191	typedef struct dhd_pktgen {
	192	uint32 version; /* To allow structure change tracking */
	193	uint32 freq; /* Max ticks between tx/rx attempts */
	194	uint32 count; /* Test packets to send/rcv each attempt */
	195	uint32 print; /* Print counts every <print> attempts */
	196	uint32 total; /* Total packets (or bursts) */
	197	uint32 minlen; /* Minimum length of packets to send */
	198	uint32 maxlen; /* Maximum length of packets to send */
	199	uint32 numsent; /* Count of test packets sent */
	200	uint32 numrcvd; /* Count of test packets received */
	201	uint32 numfail; /* Count of test send failures */
	202	uint32 mode; /* Test mode (type of test packets) */
	203	uint32 stop; /* Stop after this many tx failures */
	204	} dhd_pktgen_t;
	205
	206	/* Version in case structure changes */
	207	#define DHD_PKTGEN_VERSION 2
	208
	209	/* Type of test packets to use */
	210	#define DHD_PKTGEN_ECHO 1 /* Send echo requests */
	211	#define DHD_PKTGEN_SEND 2 /* Send discard packets */
	212	#define DHD_PKTGEN_RXBURST 3 /* Request dongle send N packets */
	213	#define DHD_PKTGEN_RECV 4 /* Continuous rx from continuous tx dongle */
	214	#endif /* SDTEST */
	215
	216	/* Enter idle immediately (no timeout) */
	217	#define DHD_IDLE_IMMEDIATE (-1)
	218
	219	/* Values for idleclock iovar: other values are the sd_divisor to use when idle */
	220	#define DHD_IDLE_ACTIVE 0 /* Do not request any SD clock change when idle */
	221	#define DHD_IDLE_STOP (-1) /* Request SD clock be stopped (and use SD1 mode) */
	222
	223	enum dhd_maclist_xtlv_type {
	224	DHD_MACLIST_XTLV_R = 0x1,
	225	DHD_MACLIST_XTLV_X = 0x2,
	226	DHD_SVMPLIST_XTLV = 0x3
	227	};
	228
	229	typedef struct _dhd_maclist_t {
	230	uint16 version; /* Version */
	231	uint16 bytes_len; /* Total bytes length of lists, XTLV headers and paddings */
	232	uint8 plist[1]; /* Pointer to the first list */
	233	} dhd_maclist_t;
	234
	235	typedef struct _dhd_pd11regs_param {
	236	uint16 start_idx;
	237	uint8 verbose;
	238	uint8 pad;
	239	uint8 plist[1];
	240	} dhd_pd11regs_param;
	241
	242	typedef struct _dhd_pd11regs_buf {
	243	uint16 idx;
	244	uint8 pad[2];
	245	uint8 pbuf[1];
	246	} dhd_pd11regs_buf;
	247
	248	/* BT logging and memory dump */
	249
	250	#define BT_LOG_BUF_MAX_SIZE (DHD_IOCTL_MAXLEN - (2 * sizeof(int)))
	251	#define BT_LOG_BUF_NOT_AVAILABLE 0
252	#define BT_LOG_NEXT_BUF_NOT_AVAIL 1
253	#define BT_LOG_NEXT_BUF_AVAIL 2
254	#define BT_LOG_NOT_READY 3
255
256	typedef struct bt_log_buf_info {
257	int availability;
258	int size;
259	char buf[BT_LOG_BUF_MAX_SIZE];
260	} bt_log_buf_info_t;
261
262	/* request BT memory in chunks */
263	typedef struct bt_mem_req {
264	int offset; /* offset from BT memory start */
265	int buf_size; /* buffer size per chunk */
266	} bt_mem_req_t;
267
268	/* max dest supported */
269	#define DEBUG_BUF_DEST_MAX 4
270
271	/* debug buf dest stat */
272	typedef struct debug_buf_dest_stat {
273	uint32 stat[DEBUG_BUF_DEST_MAX];
274	} debug_buf_dest_stat_t;
965f77c4	275
d2839953	276	#endif /* _dhdioctl_h_ */