drivers/net/wireless/intel/iwlwifi/fw/api/paging.h

   1 /******************************************************************************
   2  *
   3  * This file is provided under a dual BSD/GPLv2 license.  When using or
   4  * redistributing this file, you may do so under either license.
   5  *
   6  * GPL LICENSE SUMMARY
   7  *
   8  * Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved.
   9  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
  10  * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of version 2 of the GNU General Public License as
  14  * published by the Free Software Foundation.
  15  *
  16  * This program is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * General Public License for more details.
  20  *
  21  * The full GNU General Public License is included in this distribution
  22  * in the file called COPYING.
  23  *
  24  * Contact Information:
  25  *  Intel Linux Wireless <linuxwifi@intel.com>
  26  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  27  *
  28  * BSD LICENSE
  29  *
  30  * Copyright(c) 2005 - 2014 Intel Corporation. All rights reserved.
  31  * Copyright(c) 2013 - 2015 Intel Mobile Communications GmbH
  32  * Copyright(c) 2016 - 2017 Intel Deutschland GmbH
  33  * All rights reserved.
  34  *
  35  * Redistribution and use in source and binary forms, with or without
  36  * modification, are permitted provided that the following conditions
  37  * are met:
  38  *
  39  *  * Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  *  * Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in
  43  *    the documentation and/or other materials provided with the
  44  *    distribution.
  45  *  * Neither the name Intel Corporation nor the names of its
  46  *    contributors may be used to endorse or promote products derived
  47  *    from this software without specific prior written permission.
  48  *
  49  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  50  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  51  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  52  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  53  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  54  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  55  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  56  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  57  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  58  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  59  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  60  *
  61  *****************************************************************************/
  62 #ifndef __iwl_fw_api_paging_h__
  63 #define __iwl_fw_api_paging_h__
  64
  65 #define NUM_OF_FW_PAGING_BLOCKS 33 /* 32 for data and 1 block for CSS */
  66
  67 /**
  68  * struct iwl_fw_paging_cmd - paging layout
  69  *
  70  * Send to FW the paging layout in the driver.
  71  *
  72  * @flags: various flags for the command
  73  * @block_size: the block size in powers of 2
  74  * @block_num: number of blocks specified in the command.
  75  * @device_phy_addr: virtual addresses from device side
  76  */
  77 struct iwl_fw_paging_cmd {
  78         __le32 flags;
  79         __le32 block_size;
  80         __le32 block_num;
  81         __le32 device_phy_addr[NUM_OF_FW_PAGING_BLOCKS];
  82 } __packed; /* FW_PAGING_BLOCK_CMD_API_S_VER_1 */
  83
  84 /**
  85  * enum iwl_fw_item_id - FW item IDs
  86  *
  87  * @IWL_FW_ITEM_ID_PAGING: Address of the pages that the FW will upload
  88  *      download
  89  */
  90 enum iwl_fw_item_id {
  91         IWL_FW_ITEM_ID_PAGING = 3,
  92 };
  93
  94 /**
  95  * struct iwl_fw_get_item_cmd - get an item from the fw
  96  * @item_id: ID of item to obtain, see &enum iwl_fw_item_id
  97  */
  98 struct iwl_fw_get_item_cmd {
  99         __le32 item_id;
 100 } __packed; /* FW_GET_ITEM_CMD_API_S_VER_1 */
 101
 102 struct iwl_fw_get_item_resp {
 103         __le32 item_id;
 104         __le32 item_byte_cnt;
 105         __le32 item_val;
 106 } __packed; /* FW_GET_ITEM_RSP_S_VER_1 */
 107
 108 #endif /* __iwl_fw_api_paging_h__ */