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