212 lines
7.0 KiB
C
212 lines
7.0 KiB
C
/******************************************************************************
|
|
*
|
|
* This file is provided under a dual BSD/GPLv2 license. When using or
|
|
* redistributing this file, you may do so under either license.
|
|
*
|
|
* GPL LICENSE SUMMARY
|
|
*
|
|
* Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved.
|
|
* Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
|
|
* Copyright(c) 2016 - 2017 Intel Deutschland GmbH
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of version 2 of the GNU General Public License as
|
|
* published by the Free Software Foundation.
|
|
*
|
|
* 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.
|
|
*
|
|
* The full GNU General Public License is included in this distribution
|
|
* in the file called COPYING.
|
|
*
|
|
* Contact Information:
|
|
* Intel Linux Wireless <linuxwifi@intel.com>
|
|
* Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
|
|
*
|
|
* BSD LICENSE
|
|
*
|
|
* Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
|
|
* Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
|
|
* Copyright(c) 2016 - 2017 Intel Deutschland GmbH
|
|
* 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 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.
|
|
*
|
|
*****************************************************************************/
|
|
#ifndef __iwl_fw_api_cmdhdr_h__
|
|
#define __iwl_fw_api_cmdhdr_h__
|
|
|
|
/**
|
|
* DOC: Host command section
|
|
*
|
|
* A host command is a command issued by the upper layer to the fw. There are
|
|
* several versions of fw that have several APIs. The transport layer is
|
|
* completely agnostic to these differences.
|
|
* The transport does provide helper functionality (i.e. SYNC / ASYNC mode),
|
|
*/
|
|
#define SEQ_TO_QUEUE(s) (((s) >> 8) & 0x1f)
|
|
#define QUEUE_TO_SEQ(q) (((q) & 0x1f) << 8)
|
|
#define SEQ_TO_INDEX(s) ((s) & 0xff)
|
|
#define INDEX_TO_SEQ(i) ((i) & 0xff)
|
|
#define SEQ_RX_FRAME cpu_to_le16(0x8000)
|
|
|
|
/*
|
|
* those functions retrieve specific information from
|
|
* the id field in the iwl_host_cmd struct which contains
|
|
* the command id, the group id and the version of the command
|
|
* and vice versa
|
|
*/
|
|
static inline u8 iwl_cmd_opcode(u32 cmdid)
|
|
{
|
|
return cmdid & 0xFF;
|
|
}
|
|
|
|
static inline u8 iwl_cmd_groupid(u32 cmdid)
|
|
{
|
|
return ((cmdid & 0xFF00) >> 8);
|
|
}
|
|
|
|
static inline u8 iwl_cmd_version(u32 cmdid)
|
|
{
|
|
return ((cmdid & 0xFF0000) >> 16);
|
|
}
|
|
|
|
static inline u32 iwl_cmd_id(u8 opcode, u8 groupid, u8 version)
|
|
{
|
|
return opcode + (groupid << 8) + (version << 16);
|
|
}
|
|
|
|
/* make u16 wide id out of u8 group and opcode */
|
|
#define WIDE_ID(grp, opcode) (((grp) << 8) | (opcode))
|
|
#define DEF_ID(opcode) ((1 << 8) | (opcode))
|
|
|
|
/* due to the conversion, this group is special; new groups
|
|
* should be defined in the appropriate fw-api header files
|
|
*/
|
|
#define IWL_ALWAYS_LONG_GROUP 1
|
|
|
|
/**
|
|
* struct iwl_cmd_header - (short) command header format
|
|
*
|
|
* This header format appears in the beginning of each command sent from the
|
|
* driver, and each response/notification received from uCode.
|
|
*/
|
|
struct iwl_cmd_header {
|
|
/**
|
|
* @cmd: Command ID: REPLY_RXON, etc.
|
|
*/
|
|
u8 cmd;
|
|
/**
|
|
* @group_id: group ID, for commands with groups
|
|
*/
|
|
u8 group_id;
|
|
/**
|
|
* @sequence:
|
|
* Sequence number for the command.
|
|
*
|
|
* The driver sets up the sequence number to values of its choosing.
|
|
* uCode does not use this value, but passes it back to the driver
|
|
* when sending the response to each driver-originated command, so
|
|
* the driver can match the response to the command. Since the values
|
|
* don't get used by uCode, the driver may set up an arbitrary format.
|
|
*
|
|
* There is one exception: uCode sets bit 15 when it originates
|
|
* the response/notification, i.e. when the response/notification
|
|
* is not a direct response to a command sent by the driver. For
|
|
* example, uCode issues REPLY_RX when it sends a received frame
|
|
* to the driver; it is not a direct response to any driver command.
|
|
*
|
|
* The Linux driver uses the following format:
|
|
*
|
|
* 0:7 tfd index - position within TX queue
|
|
* 8:12 TX queue id
|
|
* 13:14 reserved
|
|
* 15 unsolicited RX or uCode-originated notification
|
|
*/
|
|
__le16 sequence;
|
|
} __packed;
|
|
|
|
/**
|
|
* struct iwl_cmd_header_wide
|
|
*
|
|
* This header format appears in the beginning of each command sent from the
|
|
* driver, and each response/notification received from uCode.
|
|
* this is the wide version that contains more information about the command
|
|
* like length, version and command type
|
|
*
|
|
* @cmd: command ID, like in &struct iwl_cmd_header
|
|
* @group_id: group ID, like in &struct iwl_cmd_header
|
|
* @sequence: sequence, like in &struct iwl_cmd_header
|
|
* @length: length of the command
|
|
* @reserved: reserved
|
|
* @version: command version
|
|
*/
|
|
struct iwl_cmd_header_wide {
|
|
u8 cmd;
|
|
u8 group_id;
|
|
__le16 sequence;
|
|
__le16 length;
|
|
u8 reserved;
|
|
u8 version;
|
|
} __packed;
|
|
|
|
/**
|
|
* struct iwl_calib_res_notif_phy_db - Receive phy db chunk after calibrations
|
|
* @type: type of the result - mostly ignored
|
|
* @length: length of the data
|
|
* @data: data, length in @length
|
|
*/
|
|
struct iwl_calib_res_notif_phy_db {
|
|
__le16 type;
|
|
__le16 length;
|
|
u8 data[];
|
|
} __packed;
|
|
|
|
/**
|
|
* struct iwl_phy_db_cmd - configure operational ucode
|
|
* @type: type of the data
|
|
* @length: length of the data
|
|
* @data: data, length in @length
|
|
*/
|
|
struct iwl_phy_db_cmd {
|
|
__le16 type;
|
|
__le16 length;
|
|
u8 data[];
|
|
} __packed;
|
|
|
|
/**
|
|
* struct iwl_cmd_response - generic response struct for most commands
|
|
* @status: status of the command asked, changes for each one
|
|
*/
|
|
struct iwl_cmd_response {
|
|
__le32 status;
|
|
};
|
|
|
|
#endif /* __iwl_fw_api_cmdhdr_h__ */
|