[net-next-2.6.git] / include / linux / wimax / i2400m.h

/*
 * Intel Wireless WiMax Connection 2400m
 * Host-Device protocol interface definitions
 *
 *
 * Copyright (C) 2007-2008 Intel Corporation. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in
 *     the documentation and/or other materials provided with the
 *     distribution.
 *   * Neither the name of Intel Corporation nor the names of its
 *     contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Intel Corporation <linux-wimax@intel.com>
 * Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
 *  - Initial implementation
 *
 *
 * This header defines the data structures and constants used to
 * communicate with the device.
 *
 * BOOTMODE/BOOTROM/FIRMWARE UPLOAD PROTOCOL
 *
 * The firmware upload protocol is quite simple and only requires a
 * handful of commands. See drivers/net/wimax/i2400m/fw.c for more
 * details.
 *
 * The BCF data structure is for the firmware file header.
 *
 *
 * THE DATA / CONTROL PROTOCOL
 *
 * This is the normal protocol spoken with the device once the
 * firmware is uploaded. It transports data payloads and control
 * messages back and forth.
 *
 * It consists 'messages' that pack one or more payloads each. The
 * format is described in detail in drivers/net/wimax/i2400m/rx.c and
 * tx.c.
 *
 *
 * THE L3L4 PROTOCOL
 *
 * The term L3L4 refers to Layer 3 (the device), Layer 4 (the
 * driver/host software).
 *
 * This is the control protocol used by the host to control the i2400m
 * device (scan, connect, disconnect...). This is sent to / received
 * as control frames. These frames consist of a header and zero or
 * more TLVs with information. We call each control frame a "message".
 *
 * Each message is composed of:
 *
 * HEADER
 * [TLV0 + PAYLOAD0]
 * [TLV1 + PAYLOAD1]
 * [...]
 * [TLVN + PAYLOADN]
 *
 * The HEADER is defined by 'struct i2400m_l3l4_hdr'. The payloads are
 * defined by a TLV structure (Type Length Value) which is a 'header'
 * (struct i2400m_tlv_hdr) and then the payload.
 *
 * All integers are represented as Little Endian.
 *
 * - REQUESTS AND EVENTS
 *
 * The requests can be clasified as follows:
 *
 *   COMMAND:  implies a request from the host to the device requesting
 *             an action being performed. The device will reply with a
 *             message (with the same type as the command), status and
 *             no (TLV) payload. Execution of a command might cause
 *             events (of different type) to be sent later on as
 *             device's state changes.
 *
 *   GET/SET:  similar to COMMAND, but will not cause other
 *             EVENTs. The reply, in the case of GET, will contain
 *             TLVs with the requested information.
 *
 *   EVENT:    asynchronous messages sent from the device, maybe as a
 *             consequence of previous COMMANDs but disassociated from
 *             them.
 *
 * Only one request might be pending at the same time (ie: don't
 * parallelize nor post another GET request before the previous
 * COMMAND has been acknowledged with it's corresponding reply by the
 * device).
 *
 * The different requests and their formats are described below:
 *
 *  I2400M_MT_*   Message types
 *  I2400M_MS_*   Message status (for replies, events)
 *  i2400m_tlv_*  TLVs
 *
 * data types are named 'struct i2400m_msg_OPNAME', OPNAME matching the
 * operation.
 */

#ifndef __LINUX__WIMAX__I2400M_H__
#define __LINUX__WIMAX__I2400M_H__

#include <linux/types.h>


/*
 * Host Device Interface (HDI) common to all busses
 */

/* Boot-mode (firmware upload mode) commands */

/* Header for the firmware file */
struct i2400m_bcf_hdr {
	__le32 module_type;
	__le32 header_len;
	__le32 header_version;
	__le32 module_id;
	__le32 module_vendor;
	__le32 date;		/* BCD YYYMMDD */
	__le32 size;
	__le32 key_size;	/* in dwords */
	__le32 modulus_size;	/* in dwords */
	__le32 exponent_size;	/* in dwords */
	__u8 reserved[88];
} __attribute__ ((packed));

/* Boot mode opcodes */
enum i2400m_brh_opcode {
	I2400M_BRH_READ = 1,
	I2400M_BRH_WRITE = 2,
	I2400M_BRH_JUMP = 3,
	I2400M_BRH_SIGNED_JUMP = 8,
	I2400M_BRH_HASH_PAYLOAD_ONLY = 9,
};

/* Boot mode command masks and stuff */
enum i2400m_brh {
	I2400M_BRH_SIGNATURE = 0xcbbc0000,
	I2400M_BRH_SIGNATURE_MASK = 0xffff0000,
	I2400M_BRH_SIGNATURE_SHIFT = 16,
	I2400M_BRH_OPCODE_MASK = 0x0000000f,
	I2400M_BRH_RESPONSE_MASK = 0x000000f0,
	I2400M_BRH_RESPONSE_SHIFT = 4,
	I2400M_BRH_DIRECT_ACCESS = 0x00000400,
	I2400M_BRH_RESPONSE_REQUIRED = 0x00000200,
	I2400M_BRH_USE_CHECKSUM = 0x00000100,
};


/* Constants for bcf->module_id */
enum i2400m_bcf_mod_id {
	/* Firmware file carries its own pokes -- pokes are a set of
	 * magical values that have to be written in certain memory
	 * addresses to get the device up and ready for firmware
	 * download when it is in non-signed boot mode. */
	I2400M_BCF_MOD_ID_POKES = 0x000000001,
};


/**
 * i2400m_bootrom_header - Header for a boot-mode command
 *
 * @cmd: the above command descriptor
 * @target_addr: where on the device memory should the action be performed.
 * @data_size: for read/write, amount of data to be read/written
 * @block_checksum: checksum value (if applicable)
 * @payload: the beginning of data attached to this header
 */
struct i2400m_bootrom_header {
	__le32 command;		/* Compose with enum i2400_brh */
	__le32 target_addr;
	__le32 data_size;
	__le32 block_checksum;
	char payload[0];
} __attribute__ ((packed));


/*
 * Data / control protocol
 */

/* Packet types for the host-device interface */
enum i2400m_pt {
	I2400M_PT_DATA = 0,
	I2400M_PT_CTRL,
	I2400M_PT_TRACE,	/* For device debug */
	I2400M_PT_RESET_WARM,	/* device reset */
	I2400M_PT_RESET_COLD,	/* USB[transport] reset, like reconnect */
	I2400M_PT_ILLEGAL
};


/*
 * Payload for a data packet
 *
 * This is prefixed to each and every outgoing DATA type.
 */
struct i2400m_pl_data_hdr {
	__le32 reserved;
} __attribute__((packed));


/* Misc constants */
enum {
	I2400M_PL_PAD = 16,	/* Payload data size alignment */
	I2400M_PL_SIZE_MAX = 0x3EFF,
	I2400M_MAX_PLS_IN_MSG = 60,
	/* protocol barkers: sync sequences; for notifications they
	 * are sent in groups of four. */
	I2400M_H2D_PREVIEW_BARKER = 0xcafe900d,
	I2400M_COLD_RESET_BARKER = 0xc01dc01d,
	I2400M_WARM_RESET_BARKER = 0x50f750f7,
	I2400M_NBOOT_BARKER = 0xdeadbeef,
	I2400M_SBOOT_BARKER = 0x0ff1c1a1,
	I2400M_ACK_BARKER = 0xfeedbabe,
	I2400M_D2H_MSG_BARKER = 0xbeefbabe,
};


/*
 * Hardware payload descriptor
 *
 * Bitfields encoded in a struct to enforce typing semantics.
 *
 * Look in rx.c and tx.c for a full description of the format.
 */
struct i2400m_pld {
	__le32 val;
} __attribute__ ((packed));

#define I2400M_PLD_SIZE_MASK 0x00003fff
#define I2400M_PLD_TYPE_SHIFT 16
#define I2400M_PLD_TYPE_MASK 0x000f0000

/*
 * Header for a TX message or RX message
 *
 * @barker: preamble
 * @size: used for management of the FIFO queue buffer; before
 *     sending, this is converted to be a real preamble. This
 *     indicates the real size of the TX message that starts at this
 *     point. If the highest bit is set, then this message is to be
 *     skipped.
 * @sequence: sequence number of this message
 * @offset: offset where the message itself starts -- see the comments
 *     in the file header about message header and payload descriptor
 *     alignment.
 * @num_pls: number of payloads in this message
 * @padding: amount of padding bytes at the end of the message to make
 *           it be of block-size aligned
 *
 * Look in rx.c and tx.c for a full description of the format.
 */
struct i2400m_msg_hdr {
	union {
		__le32 barker;
		__u32 size;	/* same size type as barker!! */
	};
	union {
		__le32 sequence;
		__u32 offset;	/* same size type as barker!! */
	};
	__le16 num_pls;
	__le16 rsv1;
	__le16 padding;
	__le16 rsv2;
	struct i2400m_pld pld[0];
} __attribute__ ((packed));


/*
 * L3/L4 control protocol
 */

enum {
	/* Interface version */
	I2400M_L3L4_VERSION             = 0x0100,
};

/* Message types */
enum i2400m_mt {
	I2400M_MT_RESERVED              = 0x0000,
	I2400M_MT_INVALID               = 0xffff,
	I2400M_MT_REPORT_MASK		= 0x8000,

	I2400M_MT_GET_SCAN_RESULT  	= 0x4202,
	I2400M_MT_SET_SCAN_PARAM   	= 0x4402,
	I2400M_MT_CMD_RF_CONTROL   	= 0x4602,
	I2400M_MT_CMD_SCAN         	= 0x4603,
	I2400M_MT_CMD_CONNECT      	= 0x4604,
	I2400M_MT_CMD_DISCONNECT   	= 0x4605,
	I2400M_MT_CMD_EXIT_IDLE   	= 0x4606,
	I2400M_MT_GET_LM_VERSION   	= 0x5201,
	I2400M_MT_GET_DEVICE_INFO  	= 0x5202,
	I2400M_MT_GET_LINK_STATUS  	= 0x5203,
	I2400M_MT_GET_STATISTICS   	= 0x5204,
	I2400M_MT_GET_STATE        	= 0x5205,
	I2400M_MT_GET_MEDIA_STATUS	= 0x5206,
	I2400M_MT_SET_INIT_CONFIG	= 0x5404,
	I2400M_MT_CMD_INIT	        = 0x5601,
	I2400M_MT_CMD_TERMINATE		= 0x5602,
	I2400M_MT_CMD_MODE_OF_OP	= 0x5603,
	I2400M_MT_CMD_RESET_DEVICE	= 0x5604,
	I2400M_MT_CMD_MONITOR_CONTROL   = 0x5605,
	I2400M_MT_CMD_ENTER_POWERSAVE   = 0x5606,
	I2400M_MT_GET_TLS_OPERATION_RESULT = 0x6201,
	I2400M_MT_SET_EAP_SUCCESS       = 0x6402,
	I2400M_MT_SET_EAP_FAIL          = 0x6403,
	I2400M_MT_SET_EAP_KEY          	= 0x6404,
	I2400M_MT_CMD_SEND_EAP_RESPONSE = 0x6602,
	I2400M_MT_REPORT_SCAN_RESULT    = 0xc002,
	I2400M_MT_REPORT_STATE		= 0xd002,
	I2400M_MT_REPORT_POWERSAVE_READY = 0xd005,
	I2400M_MT_REPORT_EAP_REQUEST    = 0xe002,
	I2400M_MT_REPORT_EAP_RESTART    = 0xe003,
	I2400M_MT_REPORT_ALT_ACCEPT    	= 0xe004,
	I2400M_MT_REPORT_KEY_REQUEST 	= 0xe005,
};


/*
 * Message Ack Status codes
 *
 * When a message is replied-to, this status is reported.
 */
enum i2400m_ms {
	I2400M_MS_DONE_OK                  = 0,
	I2400M_MS_DONE_IN_PROGRESS         = 1,
	I2400M_MS_INVALID_OP               = 2,
	I2400M_MS_BAD_STATE                = 3,
	I2400M_MS_ILLEGAL_VALUE            = 4,
	I2400M_MS_MISSING_PARAMS           = 5,
	I2400M_MS_VERSION_ERROR            = 6,
	I2400M_MS_ACCESSIBILITY_ERROR      = 7,
	I2400M_MS_BUSY                     = 8,
	I2400M_MS_CORRUPTED_TLV            = 9,
	I2400M_MS_UNINITIALIZED            = 10,
	I2400M_MS_UNKNOWN_ERROR            = 11,
	I2400M_MS_PRODUCTION_ERROR         = 12,
	I2400M_MS_NO_RF                    = 13,
	I2400M_MS_NOT_READY_FOR_POWERSAVE  = 14,
	I2400M_MS_THERMAL_CRITICAL         = 15,
	I2400M_MS_MAX
};


/**
 * i2400m_tlv - enumeration of the different types of TLVs
 *
 * TLVs stand for type-length-value and are the header for a payload
 * composed of almost anything. Each payload has a type assigned
 * and a length.
 */
enum i2400m_tlv {
	I2400M_TLV_L4_MESSAGE_VERSIONS = 129,
	I2400M_TLV_SYSTEM_STATE = 141,
	I2400M_TLV_MEDIA_STATUS = 161,
	I2400M_TLV_RF_OPERATION = 162,
	I2400M_TLV_RF_STATUS = 163,
	I2400M_TLV_DEVICE_RESET_TYPE = 132,
	I2400M_TLV_CONFIG_IDLE_PARAMETERS = 601,
	I2400M_TLV_CONFIG_IDLE_TIMEOUT = 611,
};


struct i2400m_tlv_hdr {
	__le16 type;
	__le16 length;		/* payload's */
	__u8   pl[0];
} __attribute__((packed));


struct i2400m_l3l4_hdr {
	__le16 type;
	__le16 length;		/* payload's */
	__le16 version;
	__le16 resv1;
	__le16 status;
	__le16 resv2;
	struct i2400m_tlv_hdr pl[0];
} __attribute__((packed));


/**
 * i2400m_system_state - different states of the device
 */
enum i2400m_system_state {
	I2400M_SS_UNINITIALIZED = 1,
	I2400M_SS_INIT,
	I2400M_SS_READY,
	I2400M_SS_SCAN,
	I2400M_SS_STANDBY,
	I2400M_SS_CONNECTING,
	I2400M_SS_WIMAX_CONNECTED,
	I2400M_SS_DATA_PATH_CONNECTED,
	I2400M_SS_IDLE,
	I2400M_SS_DISCONNECTING,
	I2400M_SS_OUT_OF_ZONE,
	I2400M_SS_SLEEPACTIVE,
	I2400M_SS_PRODUCTION,
	I2400M_SS_CONFIG,
	I2400M_SS_RF_OFF,
	I2400M_SS_RF_SHUTDOWN,
	I2400M_SS_DEVICE_DISCONNECT,
	I2400M_SS_MAX,
};


/**
 * i2400m_tlv_system_state - report on the state of the system
 *
 * @state: see enum i2400m_system_state
 */
struct i2400m_tlv_system_state {
	struct i2400m_tlv_hdr hdr;
	__le32 state;
} __attribute__((packed));


struct i2400m_tlv_l4_message_versions {
	struct i2400m_tlv_hdr hdr;
	__le16 major;
	__le16 minor;
	__le16 branch;
	__le16 reserved;
} __attribute__((packed));


struct i2400m_tlv_detailed_device_info {
	struct i2400m_tlv_hdr hdr;
	__u8 reserved1[400];
	__u8 mac_address[6];
	__u8 reserved2[2];
} __attribute__((packed));


enum i2400m_rf_switch_status {
	I2400M_RF_SWITCH_ON = 1,
	I2400M_RF_SWITCH_OFF = 2,
};

struct i2400m_tlv_rf_switches_status {
	struct i2400m_tlv_hdr hdr;
	__u8 sw_rf_switch;	/* 1 ON, 2 OFF */
	__u8 hw_rf_switch;	/* 1 ON, 2 OFF */
	__u8 reserved[2];
} __attribute__((packed));


enum {
	i2400m_rf_operation_on = 1,
	i2400m_rf_operation_off = 2
};

struct i2400m_tlv_rf_operation {
	struct i2400m_tlv_hdr hdr;
	__le32 status;	/* 1 ON, 2 OFF */
} __attribute__((packed));


enum i2400m_tlv_reset_type {
	I2400M_RESET_TYPE_COLD = 1,
	I2400M_RESET_TYPE_WARM
};

struct i2400m_tlv_device_reset_type {
	struct i2400m_tlv_hdr hdr;
	__le32 reset_type;
} __attribute__((packed));


struct i2400m_tlv_config_idle_parameters {
	struct i2400m_tlv_hdr hdr;
	__le32 idle_timeout;	/* 100 to 300000 ms [5min], 100 increments
				 * 0 disabled */
	__le32 idle_paging_interval;	/* frames */
} __attribute__((packed));


enum i2400m_media_status {
	I2400M_MEDIA_STATUS_LINK_UP = 1,
	I2400M_MEDIA_STATUS_LINK_DOWN,
	I2400M_MEDIA_STATUS_LINK_RENEW,
};

struct i2400m_tlv_media_status {
	struct i2400m_tlv_hdr hdr;
	__le32 media_status;
} __attribute__((packed));


/* New in v1.4 */
struct i2400m_tlv_config_idle_timeout {
	struct i2400m_tlv_hdr hdr;
	__le32 timeout;	/* 100 to 300000 ms [5min], 100 increments
			 * 0 disabled */
} __attribute__((packed));


#endif /* #ifndef __LINUX__WIMAX__I2400M_H__ */
Commit	Line	Data
ea24652d IPG	1	/*
	2	* Intel Wireless WiMax Connection 2400m
	3	* Host-Device protocol interface definitions
	4	*
	5	*
	6	* Copyright (C) 2007-2008 Intel Corporation. All rights reserved.
	7	*
	8	* Redistribution and use in source and binary forms, with or without
	9	* modification, are permitted provided that the following conditions
	10	* are met:
	11	*
	12	* * Redistributions of source code must retain the above copyright
	13	* notice, this list of conditions and the following disclaimer.
	14	* * Redistributions in binary form must reproduce the above copyright
	15	* notice, this list of conditions and the following disclaimer in
	16	* the documentation and/or other materials provided with the
	17	* distribution.
	18	* * Neither the name of Intel Corporation nor the names of its
	19	* contributors may be used to endorse or promote products derived
	20	* from this software without specific prior written permission.
	21	*
	22	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	23	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	24	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	25	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	26	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	27	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	28	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	29	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	30	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	31	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	32	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	33	*
	34	*
	35	* Intel Corporation <linux-wimax@intel.com>
	36	* Inaky Perez-Gonzalez <inaky.perez-gonzalez@intel.com>
	37	* - Initial implementation
	38	*
	39	*
	40	* This header defines the data structures and constants used to
	41	* communicate with the device.
	42	*
	43	* BOOTMODE/BOOTROM/FIRMWARE UPLOAD PROTOCOL
	44	*
	45	* The firmware upload protocol is quite simple and only requires a
	46	* handful of commands. See drivers/net/wimax/i2400m/fw.c for more
	47	* details.
	48	*
	49	* The BCF data structure is for the firmware file header.
	50	*
	51	*
	52	* THE DATA / CONTROL PROTOCOL
	53	*
	54	* This is the normal protocol spoken with the device once the
	55	* firmware is uploaded. It transports data payloads and control
	56	* messages back and forth.
	57	*
	58	* It consists 'messages' that pack one or more payloads each. The
	59	* format is described in detail in drivers/net/wimax/i2400m/rx.c and
	60	* tx.c.
	61	*
	62	*
	63	* THE L3L4 PROTOCOL
	64	*
65	* The term L3L4 refers to Layer 3 (the device), Layer 4 (the
66	* driver/host software).
67	*
68	* This is the control protocol used by the host to control the i2400m
69	* device (scan, connect, disconnect...). This is sent to / received
70	* as control frames. These frames consist of a header and zero or
71	* more TLVs with information. We call each control frame a "message".
72	*
73	* Each message is composed of:
74	*
75	* HEADER
76	* [TLV0 + PAYLOAD0]
77	* [TLV1 + PAYLOAD1]
78	* [...]
79	* [TLVN + PAYLOADN]
80	*
81	* The HEADER is defined by 'struct i2400m_l3l4_hdr'. The payloads are
82	* defined by a TLV structure (Type Length Value) which is a 'header'
83	* (struct i2400m_tlv_hdr) and then the payload.
84	*
85	* All integers are represented as Little Endian.
86	*
87	* - REQUESTS AND EVENTS
88	*
89	* The requests can be clasified as follows:
90	*
91	* COMMAND: implies a request from the host to the device requesting
92	* an action being performed. The device will reply with a
93	* message (with the same type as the command), status and
94	* no (TLV) payload. Execution of a command might cause
95	* events (of different type) to be sent later on as
96	* device's state changes.
97	*
98	* GET/SET: similar to COMMAND, but will not cause other
99	* EVENTs. The reply, in the case of GET, will contain
100	* TLVs with the requested information.
101	*
102	* EVENT: asynchronous messages sent from the device, maybe as a
103	* consequence of previous COMMANDs but disassociated from
104	* them.
105	*
106	* Only one request might be pending at the same time (ie: don't
107	* parallelize nor post another GET request before the previous
108	* COMMAND has been acknowledged with it's corresponding reply by the
109	* device).
110	*
111	* The different requests and their formats are described below:
112	*
113	* I2400M_MT_* Message types
114	* I2400M_MS_* Message status (for replies, events)
115	* i2400m_tlv_* TLVs
116	*
117	* data types are named 'struct i2400m_msg_OPNAME', OPNAME matching the
118	* operation.
119	*/
120
121	#ifndef __LINUX__WIMAX__I2400M_H__
122	#define __LINUX__WIMAX__I2400M_H__
123
124	#include <linux/types.h>
125
126
127	/*
128	* Host Device Interface (HDI) common to all busses
129	*/
130
131	/* Boot-mode (firmware upload mode) commands */
132
133	/* Header for the firmware file */
134	struct i2400m_bcf_hdr {
135	__le32 module_type;
136	__le32 header_len;
137	__le32 header_version;
138	__le32 module_id;
139	__le32 module_vendor;
140	__le32 date; /* BCD YYYMMDD */
141	__le32 size;
142	__le32 key_size; /* in dwords */
143	__le32 modulus_size; /* in dwords */
144	__le32 exponent_size; /* in dwords */
145	__u8 reserved[88];
146	} __attribute__ ((packed));
147
148	/* Boot mode opcodes */
149	enum i2400m_brh_opcode {
150	I2400M_BRH_READ = 1,
151	I2400M_BRH_WRITE = 2,
152	I2400M_BRH_JUMP = 3,
153	I2400M_BRH_SIGNED_JUMP = 8,
154	I2400M_BRH_HASH_PAYLOAD_ONLY = 9,
155	};
156
157	/* Boot mode command masks and stuff */
158	enum i2400m_brh {
159	I2400M_BRH_SIGNATURE = 0xcbbc0000,
160	I2400M_BRH_SIGNATURE_MASK = 0xffff0000,
161	I2400M_BRH_SIGNATURE_SHIFT = 16,
162	I2400M_BRH_OPCODE_MASK = 0x0000000f,
163	I2400M_BRH_RESPONSE_MASK = 0x000000f0,
164	I2400M_BRH_RESPONSE_SHIFT = 4,
165	I2400M_BRH_DIRECT_ACCESS = 0x00000400,
166	I2400M_BRH_RESPONSE_REQUIRED = 0x00000200,
167	I2400M_BRH_USE_CHECKSUM = 0x00000100,
168	};
169
170
171	/* Constants for bcf->module_id */
172	enum i2400m_bcf_mod_id {
173	/* Firmware file carries its own pokes -- pokes are a set of
174	* magical values that have to be written in certain memory
175	* addresses to get the device up and ready for firmware
176	* download when it is in non-signed boot mode. */
177	I2400M_BCF_MOD_ID_POKES = 0x000000001,
178	};
179
180
181	/**
182	* i2400m_bootrom_header - Header for a boot-mode command
183	*
184	* @cmd: the above command descriptor
185	* @target_addr: where on the device memory should the action be performed.
186	* @data_size: for read/write, amount of data to be read/written
187	* @block_checksum: checksum value (if applicable)
188	* @payload: the beginning of data attached to this header
189	*/
190	struct i2400m_bootrom_header {
191	__le32 command; /* Compose with enum i2400_brh */
192	__le32 target_addr;
193	__le32 data_size;
194	__le32 block_checksum;
195	char payload[0];
196	} __attribute__ ((packed));
197
198
199	/*
200	* Data / control protocol
201	*/
202
203	/* Packet types for the host-device interface */
204	enum i2400m_pt {
205	I2400M_PT_DATA = 0,
206	I2400M_PT_CTRL,
207	I2400M_PT_TRACE, /* For device debug */
208	I2400M_PT_RESET_WARM, /* device reset */
209	I2400M_PT_RESET_COLD, /* USB[transport] reset, like reconnect */
210	I2400M_PT_ILLEGAL
211	};
212
213
214	/*
215	* Payload for a data packet
216	*
217	* This is prefixed to each and every outgoing DATA type.
218	*/
219	struct i2400m_pl_data_hdr {
220	__le32 reserved;
221	} __attribute__((packed));
222
223
224	/* Misc constants */
225	enum {
226	I2400M_PL_PAD = 16, /* Payload data size alignment */
227	I2400M_PL_SIZE_MAX = 0x3EFF,
228	I2400M_MAX_PLS_IN_MSG = 60,
229	/* protocol barkers: sync sequences; for notifications they
230	* are sent in groups of four. */
231	I2400M_H2D_PREVIEW_BARKER = 0xcafe900d,
232	I2400M_COLD_RESET_BARKER = 0xc01dc01d,
233	I2400M_WARM_RESET_BARKER = 0x50f750f7,
234	I2400M_NBOOT_BARKER = 0xdeadbeef,
235	I2400M_SBOOT_BARKER = 0x0ff1c1a1,
236	I2400M_ACK_BARKER = 0xfeedbabe,
237	I2400M_D2H_MSG_BARKER = 0xbeefbabe,
238	};
239
240
241	/*
242	* Hardware payload descriptor
243	*
244	* Bitfields encoded in a struct to enforce typing semantics.
245	*
246	* Look in rx.c and tx.c for a full description of the format.
247	*/
248	struct i2400m_pld {
249	__le32 val;
250	} __attribute__ ((packed));
251
252	#define I2400M_PLD_SIZE_MASK 0x00003fff
253	#define I2400M_PLD_TYPE_SHIFT 16
254	#define I2400M_PLD_TYPE_MASK 0x000f0000
255
256	/*
257	* Header for a TX message or RX message
258	*
259	* @barker: preamble
260	* @size: used for management of the FIFO queue buffer; before
261	* sending, this is converted to be a real preamble. This
262	* indicates the real size of the TX message that starts at this
263	* point. If the highest bit is set, then this message is to be
264	* skipped.
265	* @sequence: sequence number of this message
266	* @offset: offset where the message itself starts -- see the comments
267	* in the file header about message header and payload descriptor
268	* alignment.
269	* @num_pls: number of payloads in this message
270	* @padding: amount of padding bytes at the end of the message to make
271	* it be of block-size aligned
272	*
273	* Look in rx.c and tx.c for a full description of the format.
274	*/
275	struct i2400m_msg_hdr {
276	union {
277	__le32 barker;
278	__u32 size; /* same size type as barker!! */
279	};
280	union {
281	__le32 sequence;
282	__u32 offset; /* same size type as barker!! */
283	};
284	__le16 num_pls;
285	__le16 rsv1;
286	__le16 padding;
287	__le16 rsv2;
288	struct i2400m_pld pld[0];
289	} __attribute__ ((packed));
290
291
292
293	/*
294	* L3/L4 control protocol
295	*/
296
297	enum {
298	/* Interface version */
299	I2400M_L3L4_VERSION = 0x0100,
300	};
301
302	/* Message types */
303	enum i2400m_mt {
304	I2400M_MT_RESERVED = 0x0000,
305	I2400M_MT_INVALID = 0xffff,
306	I2400M_MT_REPORT_MASK = 0x8000,
307
308	I2400M_MT_GET_SCAN_RESULT = 0x4202,
309	I2400M_MT_SET_SCAN_PARAM = 0x4402,
310	I2400M_MT_CMD_RF_CONTROL = 0x4602,
311	I2400M_MT_CMD_SCAN = 0x4603,
312	I2400M_MT_CMD_CONNECT = 0x4604,
313	I2400M_MT_CMD_DISCONNECT = 0x4605,
314	I2400M_MT_CMD_EXIT_IDLE = 0x4606,
315	I2400M_MT_GET_LM_VERSION = 0x5201,
316	I2400M_MT_GET_DEVICE_INFO = 0x5202,
317	I2400M_MT_GET_LINK_STATUS = 0x5203,
318	I2400M_MT_GET_STATISTICS = 0x5204,
319	I2400M_MT_GET_STATE = 0x5205,
320	I2400M_MT_GET_MEDIA_STATUS = 0x5206,
321	I2400M_MT_SET_INIT_CONFIG = 0x5404,
322	I2400M_MT_CMD_INIT = 0x5601,
323	I2400M_MT_CMD_TERMINATE = 0x5602,
324	I2400M_MT_CMD_MODE_OF_OP = 0x5603,
325	I2400M_MT_CMD_RESET_DEVICE = 0x5604,
326	I2400M_MT_CMD_MONITOR_CONTROL = 0x5605,
327	I2400M_MT_CMD_ENTER_POWERSAVE = 0x5606,
328	I2400M_MT_GET_TLS_OPERATION_RESULT = 0x6201,
329	I2400M_MT_SET_EAP_SUCCESS = 0x6402,
330	I2400M_MT_SET_EAP_FAIL = 0x6403,
331	I2400M_MT_SET_EAP_KEY = 0x6404,
332	I2400M_MT_CMD_SEND_EAP_RESPONSE = 0x6602,
333	I2400M_MT_REPORT_SCAN_RESULT = 0xc002,
334	I2400M_MT_REPORT_STATE = 0xd002,
335	I2400M_MT_REPORT_POWERSAVE_READY = 0xd005,
336	I2400M_MT_REPORT_EAP_REQUEST = 0xe002,
337	I2400M_MT_REPORT_EAP_RESTART = 0xe003,
338	I2400M_MT_REPORT_ALT_ACCEPT = 0xe004,
339	I2400M_MT_REPORT_KEY_REQUEST = 0xe005,
340	};
341
342
343	/*
344	* Message Ack Status codes
345	*
346	* When a message is replied-to, this status is reported.
347	*/
348	enum i2400m_ms {
349	I2400M_MS_DONE_OK = 0,
350	I2400M_MS_DONE_IN_PROGRESS = 1,
351	I2400M_MS_INVALID_OP = 2,
352	I2400M_MS_BAD_STATE = 3,
353	I2400M_MS_ILLEGAL_VALUE = 4,
354	I2400M_MS_MISSING_PARAMS = 5,
355	I2400M_MS_VERSION_ERROR = 6,
356	I2400M_MS_ACCESSIBILITY_ERROR = 7,
357	I2400M_MS_BUSY = 8,
358	I2400M_MS_CORRUPTED_TLV = 9,
359	I2400M_MS_UNINITIALIZED = 10,
360	I2400M_MS_UNKNOWN_ERROR = 11,
361	I2400M_MS_PRODUCTION_ERROR = 12,
362	I2400M_MS_NO_RF = 13,
363	I2400M_MS_NOT_READY_FOR_POWERSAVE = 14,
364	I2400M_MS_THERMAL_CRITICAL = 15,
365	I2400M_MS_MAX
366	};
367
368
369	/**
370	* i2400m_tlv - enumeration of the different types of TLVs
371	*
372	* TLVs stand for type-length-value and are the header for a payload
373	* composed of almost anything. Each payload has a type assigned
374	* and a length.
375	*/
376	enum i2400m_tlv {
377	I2400M_TLV_L4_MESSAGE_VERSIONS = 129,
378	I2400M_TLV_SYSTEM_STATE = 141,
379	I2400M_TLV_MEDIA_STATUS = 161,
380	I2400M_TLV_RF_OPERATION = 162,
381	I2400M_TLV_RF_STATUS = 163,
382	I2400M_TLV_DEVICE_RESET_TYPE = 132,
383	I2400M_TLV_CONFIG_IDLE_PARAMETERS = 601,
8987691a	384	I2400M_TLV_CONFIG_IDLE_TIMEOUT = 611,
ea24652d IPG	385	};
	386
	387
	388	struct i2400m_tlv_hdr {
	389	__le16 type;
	390	__le16 length; /* payload's */
	391	__u8 pl[0];
	392	} __attribute__((packed));
	393
	394
	395	struct i2400m_l3l4_hdr {
	396	__le16 type;
	397	__le16 length; /* payload's */
	398	__le16 version;
	399	__le16 resv1;
	400	__le16 status;
	401	__le16 resv2;
	402	struct i2400m_tlv_hdr pl[0];
	403	} __attribute__((packed));
	404
	405
	406	/**
	407	* i2400m_system_state - different states of the device
	408	*/
	409	enum i2400m_system_state {
	410	I2400M_SS_UNINITIALIZED = 1,
	411	I2400M_SS_INIT,
	412	I2400M_SS_READY,
	413	I2400M_SS_SCAN,
	414	I2400M_SS_STANDBY,
	415	I2400M_SS_CONNECTING,
	416	I2400M_SS_WIMAX_CONNECTED,
	417	I2400M_SS_DATA_PATH_CONNECTED,
	418	I2400M_SS_IDLE,
	419	I2400M_SS_DISCONNECTING,
	420	I2400M_SS_OUT_OF_ZONE,
	421	I2400M_SS_SLEEPACTIVE,
	422	I2400M_SS_PRODUCTION,
	423	I2400M_SS_CONFIG,
	424	I2400M_SS_RF_OFF,
	425	I2400M_SS_RF_SHUTDOWN,
	426	I2400M_SS_DEVICE_DISCONNECT,
	427	I2400M_SS_MAX,
	428	};
	429
	430
	431	/**
	432	* i2400m_tlv_system_state - report on the state of the system
	433	*
	434	* @state: see enum i2400m_system_state
	435	*/
	436	struct i2400m_tlv_system_state {
	437	struct i2400m_tlv_hdr hdr;
	438	__le32 state;
	439	} __attribute__((packed));
	440
	441
	442	struct i2400m_tlv_l4_message_versions {
	443	struct i2400m_tlv_hdr hdr;
	444	__le16 major;
	445	__le16 minor;
	446	__le16 branch;
	447	__le16 reserved;
	448	} __attribute__((packed));
449
450
451	struct i2400m_tlv_detailed_device_info {
452	struct i2400m_tlv_hdr hdr;
453	__u8 reserved1[400];
454	__u8 mac_address[6];
455	__u8 reserved2[2];
456	} __attribute__((packed));
457
458
459	enum i2400m_rf_switch_status {
460	I2400M_RF_SWITCH_ON = 1,
461	I2400M_RF_SWITCH_OFF = 2,
462	};
463
464	struct i2400m_tlv_rf_switches_status {
465	struct i2400m_tlv_hdr hdr;
466	__u8 sw_rf_switch; /* 1 ON, 2 OFF */
467	__u8 hw_rf_switch; /* 1 ON, 2 OFF */
468	__u8 reserved[2];
469	} __attribute__((packed));
470
471
472	enum {
473	i2400m_rf_operation_on = 1,
474	i2400m_rf_operation_off = 2
475	};
476
477	struct i2400m_tlv_rf_operation {
478	struct i2400m_tlv_hdr hdr;
479	__le32 status; /* 1 ON, 2 OFF */
480	} __attribute__((packed));
481
482
483	enum i2400m_tlv_reset_type {
484	I2400M_RESET_TYPE_COLD = 1,
485	I2400M_RESET_TYPE_WARM
486	};
487
488	struct i2400m_tlv_device_reset_type {
489	struct i2400m_tlv_hdr hdr;
490	__le32 reset_type;
491	} __attribute__((packed));
492
493
494	struct i2400m_tlv_config_idle_parameters {
495	struct i2400m_tlv_hdr hdr;
496	__le32 idle_timeout; /* 100 to 300000 ms [5min], 100 increments
497	* 0 disabled */
498	__le32 idle_paging_interval; /* frames */
499	} __attribute__((packed));
500
501
502	enum i2400m_media_status {
503	I2400M_MEDIA_STATUS_LINK_UP = 1,
504	I2400M_MEDIA_STATUS_LINK_DOWN,
505	I2400M_MEDIA_STATUS_LINK_RENEW,
506	};
507
508	struct i2400m_tlv_media_status {
509	struct i2400m_tlv_hdr hdr;
510	__le32 media_status;
511	} __attribute__((packed));
512
8987691a IPG	513
	514	/* New in v1.4 */
	515	struct i2400m_tlv_config_idle_timeout {
	516	struct i2400m_tlv_hdr hdr;
	517	__le32 timeout; /* 100 to 300000 ms [5min], 100 increments
	518	* 0 disabled */
	519	} __attribute__((packed));
	520
	521
ea24652d	522	#endif /* #ifndef __LINUX__WIMAX__I2400M_H__ */