drivers/net/wireless/intel/iwlwifi/fw/api/context.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) 2012 - 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) 2012 - 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
  63 #ifndef __iwl_fw_api_context_h__
  64 #define __iwl_fw_api_context_h__
  65
  66 /**
  67  * enum iwl_ctxt_id_and_color - ID and color fields in context dword
  68  * @FW_CTXT_ID_POS: position of the ID
  69  * @FW_CTXT_ID_MSK: mask of the ID
  70  * @FW_CTXT_COLOR_POS: position of the color
  71  * @FW_CTXT_COLOR_MSK: mask of the color
  72  * @FW_CTXT_INVALID: value used to indicate unused/invalid
  73  */
  74 enum iwl_ctxt_id_and_color {
  75         FW_CTXT_ID_POS          = 0,
  76         FW_CTXT_ID_MSK          = 0xff << FW_CTXT_ID_POS,
  77         FW_CTXT_COLOR_POS       = 8,
  78         FW_CTXT_COLOR_MSK       = 0xff << FW_CTXT_COLOR_POS,
  79         FW_CTXT_INVALID         = 0xffffffff,
  80 };
  81
  82 #define FW_CMD_ID_AND_COLOR(_id, _color) (((_id) << FW_CTXT_ID_POS) |\
  83                                           ((_color) << FW_CTXT_COLOR_POS))
  84
  85 /* Possible actions on PHYs, MACs and Bindings */
  86 enum iwl_ctxt_action {
  87         FW_CTXT_ACTION_STUB = 0,
  88         FW_CTXT_ACTION_ADD,
  89         FW_CTXT_ACTION_MODIFY,
  90         FW_CTXT_ACTION_REMOVE,
  91         FW_CTXT_ACTION_NUM
  92 }; /* COMMON_CONTEXT_ACTION_API_E_VER_1 */
  93
  94 #endif /* __iwl_fw_api_context_h__ */