xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/intel/iwlwifi/dvm/tt.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /******************************************************************************
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright(c) 2007 - 2014 Intel Corporation. All rights reserved.
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Portions of this file are derived from the ipw3945 project, as well
7*4882a593Smuzhiyun  * as portions of the ieee80211 subsystem header files.
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * Contact Information:
10*4882a593Smuzhiyun  *  Intel Linux Wireless <linuxwifi@intel.com>
11*4882a593Smuzhiyun  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
12*4882a593Smuzhiyun  *****************************************************************************/
13*4882a593Smuzhiyun #ifndef __iwl_tt_setting_h__
14*4882a593Smuzhiyun #define __iwl_tt_setting_h__
15*4882a593Smuzhiyun 
16*4882a593Smuzhiyun #include "commands.h"
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #define IWL_ABSOLUTE_ZERO		0
19*4882a593Smuzhiyun #define IWL_ABSOLUTE_MAX		0xFFFFFFFF
20*4882a593Smuzhiyun #define IWL_TT_INCREASE_MARGIN	5
21*4882a593Smuzhiyun #define IWL_TT_CT_KILL_MARGIN	3
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun enum iwl_antenna_ok {
24*4882a593Smuzhiyun 	IWL_ANT_OK_NONE,
25*4882a593Smuzhiyun 	IWL_ANT_OK_SINGLE,
26*4882a593Smuzhiyun 	IWL_ANT_OK_MULTI,
27*4882a593Smuzhiyun };
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun /* Thermal Throttling State Machine states */
30*4882a593Smuzhiyun enum  iwl_tt_state {
31*4882a593Smuzhiyun 	IWL_TI_0,	/* normal temperature, system power state */
32*4882a593Smuzhiyun 	IWL_TI_1,	/* high temperature detect, low power state */
33*4882a593Smuzhiyun 	IWL_TI_2,	/* higher temperature detected, lower power state */
34*4882a593Smuzhiyun 	IWL_TI_CT_KILL, /* critical temperature detected, lowest power state */
35*4882a593Smuzhiyun 	IWL_TI_STATE_MAX
36*4882a593Smuzhiyun };
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun /**
39*4882a593Smuzhiyun  * struct iwl_tt_restriction - Thermal Throttling restriction table
40*4882a593Smuzhiyun  * @tx_stream: number of tx stream allowed
41*4882a593Smuzhiyun  * @is_ht: ht enable/disable
42*4882a593Smuzhiyun  * @rx_stream: number of rx stream allowed
43*4882a593Smuzhiyun  *
44*4882a593Smuzhiyun  * This table is used by advance thermal throttling management
45*4882a593Smuzhiyun  * based on the current thermal throttling state, and determines
46*4882a593Smuzhiyun  * the number of tx/rx streams and the status of HT operation.
47*4882a593Smuzhiyun  */
48*4882a593Smuzhiyun struct iwl_tt_restriction {
49*4882a593Smuzhiyun 	enum iwl_antenna_ok tx_stream;
50*4882a593Smuzhiyun 	enum iwl_antenna_ok rx_stream;
51*4882a593Smuzhiyun 	bool is_ht;
52*4882a593Smuzhiyun };
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun /**
55*4882a593Smuzhiyun  * struct iwl_tt_trans - Thermal Throttling transaction table
56*4882a593Smuzhiyun  * @next_state:  next thermal throttling mode
57*4882a593Smuzhiyun  * @tt_low: low temperature threshold to change state
58*4882a593Smuzhiyun  * @tt_high: high temperature threshold to change state
59*4882a593Smuzhiyun  *
60*4882a593Smuzhiyun  * This is used by the advanced thermal throttling algorithm
61*4882a593Smuzhiyun  * to determine the next thermal state to go based on the
62*4882a593Smuzhiyun  * current temperature.
63*4882a593Smuzhiyun  */
64*4882a593Smuzhiyun struct iwl_tt_trans {
65*4882a593Smuzhiyun 	enum iwl_tt_state next_state;
66*4882a593Smuzhiyun 	u32 tt_low;
67*4882a593Smuzhiyun 	u32 tt_high;
68*4882a593Smuzhiyun };
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun /**
71*4882a593Smuzhiyun  * struct iwl_tt_mgnt - Thermal Throttling Management structure
72*4882a593Smuzhiyun  * @advanced_tt:    advanced thermal throttle required
73*4882a593Smuzhiyun  * @state:          current Thermal Throttling state
74*4882a593Smuzhiyun  * @tt_power_mode:  Thermal Throttling power mode index
75*4882a593Smuzhiyun  *		    being used to set power level when
76*4882a593Smuzhiyun  *		    when thermal throttling state != IWL_TI_0
77*4882a593Smuzhiyun  *		    the tt_power_mode should set to different
78*4882a593Smuzhiyun  *		    power mode based on the current tt state
79*4882a593Smuzhiyun  * @tt_previous_temperature: last measured temperature
80*4882a593Smuzhiyun  * @iwl_tt_restriction: ptr to restriction tbl, used by advance
81*4882a593Smuzhiyun  *		    thermal throttling to determine how many tx/rx streams
82*4882a593Smuzhiyun  *		    should be used in tt state; and can HT be enabled or not
83*4882a593Smuzhiyun  * @iwl_tt_trans: ptr to adv trans table, used by advance thermal throttling
84*4882a593Smuzhiyun  *		    state transaction
85*4882a593Smuzhiyun  * @ct_kill_toggle: used to toggle the CSR bit when checking uCode temperature
86*4882a593Smuzhiyun  * @ct_kill_exit_tm: timer to exit thermal kill
87*4882a593Smuzhiyun  */
88*4882a593Smuzhiyun struct iwl_tt_mgmt {
89*4882a593Smuzhiyun 	enum iwl_tt_state state;
90*4882a593Smuzhiyun 	bool advanced_tt;
91*4882a593Smuzhiyun 	u8 tt_power_mode;
92*4882a593Smuzhiyun 	bool ct_kill_toggle;
93*4882a593Smuzhiyun #ifdef CONFIG_IWLWIFI_DEBUG
94*4882a593Smuzhiyun 	s32 tt_previous_temp;
95*4882a593Smuzhiyun #endif
96*4882a593Smuzhiyun 	struct iwl_tt_restriction *restriction;
97*4882a593Smuzhiyun 	struct iwl_tt_trans *transaction;
98*4882a593Smuzhiyun 	struct timer_list ct_kill_exit_tm;
99*4882a593Smuzhiyun 	struct timer_list ct_kill_waiting_tm;
100*4882a593Smuzhiyun };
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun u8 iwl_tt_current_power_mode(struct iwl_priv *priv);
103*4882a593Smuzhiyun bool iwl_tt_is_low_power_state(struct iwl_priv *priv);
104*4882a593Smuzhiyun bool iwl_ht_enabled(struct iwl_priv *priv);
105*4882a593Smuzhiyun enum iwl_antenna_ok iwl_tx_ant_restriction(struct iwl_priv *priv);
106*4882a593Smuzhiyun enum iwl_antenna_ok iwl_rx_ant_restriction(struct iwl_priv *priv);
107*4882a593Smuzhiyun void iwl_tt_enter_ct_kill(struct iwl_priv *priv);
108*4882a593Smuzhiyun void iwl_tt_exit_ct_kill(struct iwl_priv *priv);
109*4882a593Smuzhiyun void iwl_tt_handler(struct iwl_priv *priv);
110*4882a593Smuzhiyun void iwl_tt_initialize(struct iwl_priv *priv);
111*4882a593Smuzhiyun void iwl_tt_exit(struct iwl_priv *priv);
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun #endif  /* __iwl_tt_setting_h__ */
114