iwlwifi: refactor some thermal throttle code
[linux-2.6.git] / drivers / net / wireless / iwlwifi / iwl-power.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2007 - 2009 Intel Corporation. All rights reserved.
4  *
5  * Portions of this file are derived from the ipw3945 project, as well
6  * as portions of the ieee80211 subsystem header files.
7  *
8  * This program is free software; you can redistribute it and/or modify it
9  * under the terms of version 2 of the GNU General Public License as
10  * published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but WITHOUT
13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
15  * more details.
16  *
17  * You should have received a copy of the GNU General Public License along with
18  * this program; if not, write to the Free Software Foundation, Inc.,
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
20  *
21  * The full GNU General Public License is included in this distribution in the
22  * file called LICENSE.
23  *
24  * Contact Information:
25  *  Intel Linux Wireless <ilw@linux.intel.com>
26  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27  *****************************************************************************/
28 #ifndef __iwl_power_setting_h__
29 #define __iwl_power_setting_h__
30
31 #include <net/mac80211.h>
32 #include "iwl-commands.h"
33
34 struct iwl_priv;
35
36 #define IWL_ABSOLUTE_ZERO               0
37 #define IWL_ABSOLUTE_MAX                0xFFFFFFFF
38 #define IWL_TT_INCREASE_MARGIN  5
39
40 enum iwl_antenna_ok {
41         IWL_ANT_OK_NONE,
42         IWL_ANT_OK_SINGLE,
43         IWL_ANT_OK_MULTI,
44 };
45
46 /* Thermal Throttling State Machine states */
47 enum  iwl_tt_state {
48         IWL_TI_0,       /* normal temperature, system power state */
49         IWL_TI_1,       /* high temperature detect, low power state */
50         IWL_TI_2,       /* higher temperature detected, lower power state */
51         IWL_TI_CT_KILL, /* critical temperature detected, lowest power state */
52         IWL_TI_STATE_MAX
53 };
54
55 /**
56  * struct iwl_tt_restriction - Thermal Throttling restriction table
57  * @tx_stream: number of tx stream allowed
58  * @is_ht: ht enable/disable
59  * @rx_stream: number of rx stream allowed
60  *
61  * This table is used by advance thermal throttling management
62  * based on the current thermal throttling state, and determines
63  * the number of tx/rx streams and the status of HT operation.
64  */
65 struct iwl_tt_restriction {
66         enum iwl_antenna_ok tx_stream;
67         enum iwl_antenna_ok rx_stream;
68         bool is_ht;
69 };
70
71 /**
72  * struct iwl_tt_trans - Thermal Throttling transaction table
73  * @next_state:  next thermal throttling mode
74  * @tt_low: low temperature threshold to change state
75  * @tt_high: high temperature threshold to change state
76  *
77  * This is used by the advanced thermal throttling algorithm
78  * to determine the next thermal state to go based on the
79  * current temperature.
80  */
81 struct iwl_tt_trans {
82         enum iwl_tt_state next_state;
83         u32 tt_low;
84         u32 tt_high;
85 };
86
87 /**
88  * struct iwl_tt_mgnt - Thermal Throttling Management structure
89  * @advanced_tt:    advanced thermal throttle required
90  * @state:          current Thermal Throttling state
91  * @tt_power_mode:  Thermal Throttling power mode index
92  *                  being used to set power level when
93  *                  when thermal throttling state != IWL_TI_0
94  *                  the tt_power_mode should set to different
95  *                  power mode based on the current tt state
96  * @sys_power_mode: previous system power mode
97  *                  before transition into TT state
98  * @tt_previous_temperature: last measured temperature
99  * @iwl_tt_restriction: ptr to restriction tbl, used by advance
100  *                  thermal throttling to determine how many tx/rx streams
101  *                  should be used in tt state; and can HT be enabled or not
102  * @iwl_tt_trans: ptr to adv trans table, used by advance thermal throttling
103  *                  state transaction
104  * @ct_kill_toggle: used to toggle the CSR bit when checking uCode temperature
105  * @ct_kill_exit_tm: timer to exit thermal kill
106  */
107 struct iwl_tt_mgmt {
108         enum iwl_tt_state state;
109         bool advanced_tt;
110         u8 tt_power_mode;
111         u8 sys_power_mode;
112         bool ct_kill_toggle;
113 #ifdef CONFIG_IWLWIFI_DEBUG
114         s32 tt_previous_temp;
115 #endif
116         struct iwl_tt_restriction *restriction;
117         struct iwl_tt_trans *transaction;
118         struct timer_list ct_kill_exit_tm;
119 };
120
121 enum {
122         IWL_POWER_MODE_CAM, /* Continuously Aware Mode, always on */
123         IWL_POWER_INDEX_1,
124         IWL_POWER_INDEX_2,
125         IWL_POWER_INDEX_3,
126         IWL_POWER_INDEX_4,
127         IWL_POWER_INDEX_5,
128         IWL_POWER_NUM
129 };
130
131 /* Power management (not Tx power) structures */
132
133 struct iwl_power_vec_entry {
134         struct iwl_powertable_cmd cmd;
135         u8 no_dtim;
136 };
137
138 struct iwl_power_mgr {
139         struct iwl_power_vec_entry pwr_range_0[IWL_POWER_NUM];
140         struct iwl_power_vec_entry pwr_range_1[IWL_POWER_NUM];
141         struct iwl_power_vec_entry pwr_range_2[IWL_POWER_NUM];
142         u32 dtim_period;
143         /* final power level that used to calculate final power command */
144         u8 power_mode;
145         u8 user_power_setting; /* set by user through sysfs */
146         u8 power_disabled; /* set by mac80211's CONF_PS */
147 };
148
149 int iwl_power_update_mode(struct iwl_priv *priv, bool force);
150 int iwl_power_set_user_mode(struct iwl_priv *priv, u16 mode);
151 bool iwl_ht_enabled(struct iwl_priv *priv);
152 enum iwl_antenna_ok iwl_tx_ant_restriction(struct iwl_priv *priv);
153 enum iwl_antenna_ok iwl_rx_ant_restriction(struct iwl_priv *priv);
154 void iwl_tt_enter_ct_kill(struct iwl_priv *priv);
155 void iwl_tt_exit_ct_kill(struct iwl_priv *priv);
156 void iwl_tt_handler(struct iwl_priv *priv);
157 void iwl_tt_initialize(struct iwl_priv *priv);
158 void iwl_tt_exit(struct iwl_priv *priv);
159 void iwl_power_initialize(struct iwl_priv *priv);
160
161 #endif  /* __iwl_power_setting_h__ */