Commit | Line | Data |
---|---|---|
67351119 | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
e0eca63e VH |
2 | /* |
3 | * Universal Flash Storage Host controller driver | |
e0eca63e | 4 | * Copyright (C) 2011-2013 Samsung India Software Operations |
dc3c8d3a | 5 | * Copyright (c) 2013-2016, The Linux Foundation. All rights reserved. |
e0eca63e VH |
6 | * |
7 | * Authors: | |
8 | * Santosh Yaraganavi <santosh.sy@samsung.com> | |
9 | * Vinayak Holikatti <h.vinayak@samsung.com> | |
e0eca63e VH |
10 | */ |
11 | ||
12 | #ifndef _UFSHCD_H | |
13 | #define _UFSHCD_H | |
14 | ||
5a244e0e | 15 | #include <linux/bitfield.h> |
1e8d44bd | 16 | #include <linux/blk-crypto-profile.h> |
3f06f780 BVA |
17 | #include <linux/blk-mq.h> |
18 | #include <linux/devfreq.h> | |
19 | #include <linux/pm_runtime.h> | |
20 | #include <scsi/scsi_device.h> | |
dd11376b BVA |
21 | #include <ufs/unipro.h> |
22 | #include <ufs/ufs.h> | |
23 | #include <ufs/ufs_quirks.h> | |
24 | #include <ufs/ufshci.h> | |
e0eca63e VH |
25 | |
26 | #define UFSHCD "ufshcd" | |
e0eca63e | 27 | |
5c0c28a8 SRT |
28 | struct ufs_hba; |
29 | ||
5a0b0cb9 SRT |
30 | enum dev_cmd_type { |
31 | DEV_CMD_TYPE_NOP = 0x0, | |
68078d5c | 32 | DEV_CMD_TYPE_QUERY = 0x1, |
5a0b0cb9 SRT |
33 | }; |
34 | ||
e965e5e0 SC |
35 | enum ufs_event_type { |
36 | /* uic specific errors */ | |
37 | UFS_EVT_PA_ERR = 0, | |
38 | UFS_EVT_DL_ERR, | |
39 | UFS_EVT_NL_ERR, | |
40 | UFS_EVT_TL_ERR, | |
41 | UFS_EVT_DME_ERR, | |
42 | ||
43 | /* fatal errors */ | |
44 | UFS_EVT_AUTO_HIBERN8_ERR, | |
45 | UFS_EVT_FATAL_ERR, | |
46 | UFS_EVT_LINK_STARTUP_FAIL, | |
47 | UFS_EVT_RESUME_ERR, | |
48 | UFS_EVT_SUSPEND_ERR, | |
b294ff3e AD |
49 | UFS_EVT_WL_SUSP_ERR, |
50 | UFS_EVT_WL_RES_ERR, | |
e965e5e0 SC |
51 | |
52 | /* abnormal events */ | |
53 | UFS_EVT_DEV_RESET, | |
54 | UFS_EVT_HOST_RESET, | |
55 | UFS_EVT_ABORT, | |
56 | ||
57 | UFS_EVT_CNT, | |
58 | }; | |
59 | ||
e0eca63e VH |
60 | /** |
61 | * struct uic_command - UIC command structure | |
62 | * @command: UIC command | |
63 | * @argument1: UIC command argument 1 | |
64 | * @argument2: UIC command argument 2 | |
65 | * @argument3: UIC command argument 3 | |
0f52fcb9 | 66 | * @cmd_active: Indicate if UIC command is outstanding |
6ccf44fe | 67 | * @done: UIC command completion |
e0eca63e VH |
68 | */ |
69 | struct uic_command { | |
70 | u32 command; | |
71 | u32 argument1; | |
72 | u32 argument2; | |
73 | u32 argument3; | |
0f52fcb9 | 74 | int cmd_active; |
6ccf44fe | 75 | struct completion done; |
e0eca63e VH |
76 | }; |
77 | ||
57d104c1 SJ |
78 | /* Used to differentiate the power management options */ |
79 | enum ufs_pm_op { | |
80 | UFS_RUNTIME_PM, | |
81 | UFS_SYSTEM_PM, | |
82 | UFS_SHUTDOWN_PM, | |
83 | }; | |
84 | ||
57d104c1 SJ |
85 | /* Host <-> Device UniPro Link state */ |
86 | enum uic_link_state { | |
87 | UIC_LINK_OFF_STATE = 0, /* Link powered down or disabled */ | |
88 | UIC_LINK_ACTIVE_STATE = 1, /* Link is in Fast/Slow/Sleep state */ | |
89 | UIC_LINK_HIBERN8_STATE = 2, /* Link is in Hibernate state */ | |
4db7a236 | 90 | UIC_LINK_BROKEN_STATE = 3, /* Link is in broken state */ |
57d104c1 SJ |
91 | }; |
92 | ||
93 | #define ufshcd_is_link_off(hba) ((hba)->uic_link_state == UIC_LINK_OFF_STATE) | |
94 | #define ufshcd_is_link_active(hba) ((hba)->uic_link_state == \ | |
95 | UIC_LINK_ACTIVE_STATE) | |
96 | #define ufshcd_is_link_hibern8(hba) ((hba)->uic_link_state == \ | |
97 | UIC_LINK_HIBERN8_STATE) | |
4db7a236 CG |
98 | #define ufshcd_is_link_broken(hba) ((hba)->uic_link_state == \ |
99 | UIC_LINK_BROKEN_STATE) | |
57d104c1 SJ |
100 | #define ufshcd_set_link_off(hba) ((hba)->uic_link_state = UIC_LINK_OFF_STATE) |
101 | #define ufshcd_set_link_active(hba) ((hba)->uic_link_state = \ | |
102 | UIC_LINK_ACTIVE_STATE) | |
103 | #define ufshcd_set_link_hibern8(hba) ((hba)->uic_link_state = \ | |
104 | UIC_LINK_HIBERN8_STATE) | |
4db7a236 CG |
105 | #define ufshcd_set_link_broken(hba) ((hba)->uic_link_state = \ |
106 | UIC_LINK_BROKEN_STATE) | |
57d104c1 | 107 | |
1764fa2a SC |
108 | #define ufshcd_set_ufs_dev_active(h) \ |
109 | ((h)->curr_dev_pwr_mode = UFS_ACTIVE_PWR_MODE) | |
110 | #define ufshcd_set_ufs_dev_sleep(h) \ | |
111 | ((h)->curr_dev_pwr_mode = UFS_SLEEP_PWR_MODE) | |
112 | #define ufshcd_set_ufs_dev_poweroff(h) \ | |
113 | ((h)->curr_dev_pwr_mode = UFS_POWERDOWN_PWR_MODE) | |
fe1d4c2e AH |
114 | #define ufshcd_set_ufs_dev_deepsleep(h) \ |
115 | ((h)->curr_dev_pwr_mode = UFS_DEEPSLEEP_PWR_MODE) | |
1764fa2a SC |
116 | #define ufshcd_is_ufs_dev_active(h) \ |
117 | ((h)->curr_dev_pwr_mode == UFS_ACTIVE_PWR_MODE) | |
118 | #define ufshcd_is_ufs_dev_sleep(h) \ | |
119 | ((h)->curr_dev_pwr_mode == UFS_SLEEP_PWR_MODE) | |
120 | #define ufshcd_is_ufs_dev_poweroff(h) \ | |
121 | ((h)->curr_dev_pwr_mode == UFS_POWERDOWN_PWR_MODE) | |
fe1d4c2e AH |
122 | #define ufshcd_is_ufs_dev_deepsleep(h) \ |
123 | ((h)->curr_dev_pwr_mode == UFS_DEEPSLEEP_PWR_MODE) | |
1764fa2a | 124 | |
57d104c1 SJ |
125 | /* |
126 | * UFS Power management levels. | |
fe1d4c2e AH |
127 | * Each level is in increasing order of power savings, except DeepSleep |
128 | * which is lower than PowerDown with power on but not PowerDown with | |
129 | * power off. | |
57d104c1 SJ |
130 | */ |
131 | enum ufs_pm_level { | |
e2ac7ab2 BVA |
132 | UFS_PM_LVL_0, |
133 | UFS_PM_LVL_1, | |
134 | UFS_PM_LVL_2, | |
135 | UFS_PM_LVL_3, | |
136 | UFS_PM_LVL_4, | |
137 | UFS_PM_LVL_5, | |
138 | UFS_PM_LVL_6, | |
57d104c1 SJ |
139 | UFS_PM_LVL_MAX |
140 | }; | |
141 | ||
142 | struct ufs_pm_lvl_states { | |
143 | enum ufs_dev_pwr_mode dev_state; | |
144 | enum uic_link_state link_state; | |
145 | }; | |
146 | ||
e0eca63e VH |
147 | /** |
148 | * struct ufshcd_lrb - local reference block | |
149 | * @utr_descriptor_ptr: UTRD address of the command | |
5a0b0cb9 | 150 | * @ucd_req_ptr: UCD address of the command |
e0eca63e VH |
151 | * @ucd_rsp_ptr: Response UPIU address for this command |
152 | * @ucd_prdt_ptr: PRDT address of the command | |
ff8e20c6 DR |
153 | * @utrd_dma_addr: UTRD dma address for debug |
154 | * @ucd_prdt_dma_addr: PRDT dma address for debug | |
155 | * @ucd_rsp_dma_addr: UPIU response dma address for debug | |
156 | * @ucd_req_dma_addr: UPIU request dma address for debug | |
e0eca63e | 157 | * @cmd: pointer to SCSI command |
e0eca63e VH |
158 | * @scsi_status: SCSI status of the command |
159 | * @command_type: SCSI, UFS, Query. | |
160 | * @task_tag: Task tag of the command | |
161 | * @lun: LUN of the command | |
5a0b0cb9 | 162 | * @intr_cmd: Interrupt command (doesn't participate in interrupt aggregation) |
0f85e747 DL |
163 | * @issue_time_stamp: time stamp for debug purposes (CLOCK_MONOTONIC) |
164 | * @issue_time_stamp_local_clock: time stamp for debug purposes (local_clock) | |
165 | * @compl_time_stamp: time stamp for statistics (CLOCK_MONOTONIC) | |
166 | * @compl_time_stamp_local_clock: time stamp for debug purposes (local_clock) | |
df043c74 ST |
167 | * @crypto_key_slot: the key slot to use for inline crypto (-1 if none) |
168 | * @data_unit_num: the data unit number for the first block for inline crypto | |
e0b299e3 | 169 | * @req_abort_skip: skip request abort task flag |
e0eca63e VH |
170 | */ |
171 | struct ufshcd_lrb { | |
172 | struct utp_transfer_req_desc *utr_descriptor_ptr; | |
5a0b0cb9 | 173 | struct utp_upiu_req *ucd_req_ptr; |
e0eca63e VH |
174 | struct utp_upiu_rsp *ucd_rsp_ptr; |
175 | struct ufshcd_sg_entry *ucd_prdt_ptr; | |
176 | ||
ff8e20c6 DR |
177 | dma_addr_t utrd_dma_addr; |
178 | dma_addr_t ucd_req_dma_addr; | |
179 | dma_addr_t ucd_rsp_dma_addr; | |
180 | dma_addr_t ucd_prdt_dma_addr; | |
181 | ||
e0eca63e | 182 | struct scsi_cmnd *cmd; |
e0eca63e VH |
183 | int scsi_status; |
184 | ||
185 | int command_type; | |
186 | int task_tag; | |
0ce147d4 | 187 | u8 lun; /* UPIU LUN id field is only 8-bit wide */ |
5a0b0cb9 | 188 | bool intr_cmd; |
ff8e20c6 | 189 | ktime_t issue_time_stamp; |
0f85e747 | 190 | u64 issue_time_stamp_local_clock; |
09017188 | 191 | ktime_t compl_time_stamp; |
0f85e747 | 192 | u64 compl_time_stamp_local_clock; |
df043c74 ST |
193 | #ifdef CONFIG_SCSI_UFS_CRYPTO |
194 | int crypto_key_slot; | |
195 | u64 data_unit_num; | |
196 | #endif | |
e0b299e3 GB |
197 | |
198 | bool req_abort_skip; | |
e0eca63e VH |
199 | }; |
200 | ||
68078d5c | 201 | /** |
a230c2f6 | 202 | * struct ufs_query - holds relevant data structures for query request |
68078d5c DR |
203 | * @request: request upiu and function |
204 | * @descriptor: buffer for sending/receiving descriptor | |
205 | * @response: response upiu and response | |
206 | */ | |
207 | struct ufs_query { | |
208 | struct ufs_query_req request; | |
209 | u8 *descriptor; | |
210 | struct ufs_query_res response; | |
211 | }; | |
212 | ||
5a0b0cb9 SRT |
213 | /** |
214 | * struct ufs_dev_cmd - all assosiated fields with device management commands | |
215 | * @type: device management command type - Query, NOP OUT | |
216 | * @lock: lock to allow one command at a time | |
217 | * @complete: internal commands completion | |
cff91daf | 218 | * @query: Device management query information |
5a0b0cb9 SRT |
219 | */ |
220 | struct ufs_dev_cmd { | |
221 | enum dev_cmd_type type; | |
222 | struct mutex lock; | |
223 | struct completion *complete; | |
68078d5c | 224 | struct ufs_query query; |
5a0b0cb9 | 225 | }; |
e0eca63e | 226 | |
c6e79dac SRT |
227 | /** |
228 | * struct ufs_clk_info - UFS clock related info | |
229 | * @list: list headed by hba->clk_list_head | |
230 | * @clk: clock node | |
231 | * @name: clock name | |
232 | * @max_freq: maximum frequency supported by the clock | |
4cff6d99 | 233 | * @min_freq: min frequency that can be used for clock scaling |
856b3483 | 234 | * @curr_freq: indicates the current frequency that it is set to |
81309c24 | 235 | * @keep_link_active: indicates that the clk should not be disabled if |
cff91daf | 236 | * link is active |
c6e79dac SRT |
237 | * @enabled: variable to check against multiple enable/disable |
238 | */ | |
239 | struct ufs_clk_info { | |
240 | struct list_head list; | |
241 | struct clk *clk; | |
242 | const char *name; | |
243 | u32 max_freq; | |
4cff6d99 | 244 | u32 min_freq; |
856b3483 | 245 | u32 curr_freq; |
81309c24 | 246 | bool keep_link_active; |
c6e79dac SRT |
247 | bool enabled; |
248 | }; | |
249 | ||
f06fcc71 YG |
250 | enum ufs_notify_change_status { |
251 | PRE_CHANGE, | |
252 | POST_CHANGE, | |
253 | }; | |
7eb584db DR |
254 | |
255 | struct ufs_pa_layer_attr { | |
256 | u32 gear_rx; | |
257 | u32 gear_tx; | |
258 | u32 lane_rx; | |
259 | u32 lane_tx; | |
260 | u32 pwr_rx; | |
261 | u32 pwr_tx; | |
262 | u32 hs_rate; | |
263 | }; | |
264 | ||
265 | struct ufs_pwr_mode_info { | |
266 | bool is_valid; | |
267 | struct ufs_pa_layer_attr info; | |
268 | }; | |
269 | ||
5c0c28a8 SRT |
270 | /** |
271 | * struct ufs_hba_variant_ops - variant specific callbacks | |
272 | * @name: variant name | |
273 | * @init: called when the driver is initialized | |
274 | * @exit: called to cleanup everything done in init | |
9949e702 | 275 | * @get_ufs_hci_version: called to get UFS HCI version |
856b3483 | 276 | * @clk_scale_notify: notifies that clks are scaled up/down |
5c0c28a8 | 277 | * @setup_clocks: called before touching any of the controller registers |
5c0c28a8 SRT |
278 | * @hce_enable_notify: called before and after HCE enable bit is set to allow |
279 | * variant specific Uni-Pro initialization. | |
280 | * @link_startup_notify: called before and after Link startup is carried out | |
281 | * to allow variant specific Uni-Pro initialization. | |
7eb584db DR |
282 | * @pwr_change_notify: called before and after a power mode change |
283 | * is carried out to allow vendor spesific capabilities | |
284 | * to be set. | |
0e675efa KK |
285 | * @setup_xfer_req: called before any transfer request is issued |
286 | * to set some things | |
d2877be4 KK |
287 | * @setup_task_mgmt: called before any task management request is issued |
288 | * to set some things | |
ee32c909 | 289 | * @hibern8_notify: called around hibern8 enter/exit |
56d4a186 | 290 | * @apply_dev_quirks: called to apply device specific quirks |
cff91daf | 291 | * @fixup_dev_quirks: called to modify device specific quirks |
57d104c1 SJ |
292 | * @suspend: called during host controller PM callback |
293 | * @resume: called during host controller PM callback | |
6e3fd44d | 294 | * @dbg_register_dump: used to dump controller debug information |
4b9ffb5a | 295 | * @phy_initialization: used to initialize phys |
d8d9f793 | 296 | * @device_reset: called to issue a reset pulse on the UFS device |
cff91daf | 297 | * @config_scaling_param: called to configure clock scaling parameters |
1bc726e2 | 298 | * @program_key: program or evict an inline encryption key |
172614a9 | 299 | * @event_notify: called to notify important events |
5c0c28a8 SRT |
300 | */ |
301 | struct ufs_hba_variant_ops { | |
302 | const char *name; | |
303 | int (*init)(struct ufs_hba *); | |
304 | void (*exit)(struct ufs_hba *); | |
9949e702 | 305 | u32 (*get_ufs_hci_version)(struct ufs_hba *); |
f06fcc71 YG |
306 | int (*clk_scale_notify)(struct ufs_hba *, bool, |
307 | enum ufs_notify_change_status); | |
1e879e8f SJ |
308 | int (*setup_clocks)(struct ufs_hba *, bool, |
309 | enum ufs_notify_change_status); | |
f06fcc71 YG |
310 | int (*hce_enable_notify)(struct ufs_hba *, |
311 | enum ufs_notify_change_status); | |
312 | int (*link_startup_notify)(struct ufs_hba *, | |
313 | enum ufs_notify_change_status); | |
7eb584db | 314 | int (*pwr_change_notify)(struct ufs_hba *, |
f06fcc71 YG |
315 | enum ufs_notify_change_status status, |
316 | struct ufs_pa_layer_attr *, | |
7eb584db | 317 | struct ufs_pa_layer_attr *); |
b427609e BVA |
318 | void (*setup_xfer_req)(struct ufs_hba *hba, int tag, |
319 | bool is_scsi_cmd); | |
d2877be4 | 320 | void (*setup_task_mgmt)(struct ufs_hba *, int, u8); |
ee32c909 | 321 | void (*hibern8_notify)(struct ufs_hba *, enum uic_cmd_dme, |
56d4a186 | 322 | enum ufs_notify_change_status); |
09750066 | 323 | int (*apply_dev_quirks)(struct ufs_hba *hba); |
c28c00ba | 324 | void (*fixup_dev_quirks)(struct ufs_hba *hba); |
9561f584 PW |
325 | int (*suspend)(struct ufs_hba *, enum ufs_pm_op, |
326 | enum ufs_notify_change_status); | |
57d104c1 | 327 | int (*resume)(struct ufs_hba *, enum ufs_pm_op); |
6e3fd44d | 328 | void (*dbg_register_dump)(struct ufs_hba *hba); |
4b9ffb5a | 329 | int (*phy_initialization)(struct ufs_hba *); |
151f1b66 | 330 | int (*device_reset)(struct ufs_hba *hba); |
2c75f9a5 | 331 | void (*config_scaling_param)(struct ufs_hba *hba, |
c906e832 BVA |
332 | struct devfreq_dev_profile *profile, |
333 | struct devfreq_simple_ondemand_data *data); | |
1bc726e2 EB |
334 | int (*program_key)(struct ufs_hba *hba, |
335 | const union ufs_crypto_cfg_entry *cfg, int slot); | |
172614a9 SC |
336 | void (*event_notify)(struct ufs_hba *hba, |
337 | enum ufs_event_type evt, void *data); | |
5c0c28a8 SRT |
338 | }; |
339 | ||
1ab27c9c ST |
340 | /* clock gating state */ |
341 | enum clk_gating_state { | |
342 | CLKS_OFF, | |
343 | CLKS_ON, | |
344 | REQ_CLKS_OFF, | |
345 | REQ_CLKS_ON, | |
346 | }; | |
347 | ||
348 | /** | |
349 | * struct ufs_clk_gating - UFS clock gating related info | |
350 | * @gate_work: worker to turn off clocks after some delay as specified in | |
351 | * delay_ms | |
352 | * @ungate_work: worker to turn on clocks that will be used in case of | |
353 | * interrupt context | |
354 | * @state: the current clocks state | |
355 | * @delay_ms: gating delay in ms | |
356 | * @is_suspended: clk gating is suspended when set to 1 which can be used | |
357 | * during suspend/resume | |
358 | * @delay_attr: sysfs attribute to control delay_attr | |
b427411a ST |
359 | * @enable_attr: sysfs attribute to enable/disable clock gating |
360 | * @is_enabled: Indicates the current status of clock gating | |
4543d9d7 | 361 | * @is_initialized: Indicates whether clock gating is initialized or not |
1ab27c9c ST |
362 | * @active_reqs: number of requests that are pending and should be waited for |
363 | * completion before gating clocks. | |
cff91daf | 364 | * @clk_gating_workq: workqueue for clock gating work. |
1ab27c9c ST |
365 | */ |
366 | struct ufs_clk_gating { | |
367 | struct delayed_work gate_work; | |
368 | struct work_struct ungate_work; | |
369 | enum clk_gating_state state; | |
370 | unsigned long delay_ms; | |
371 | bool is_suspended; | |
372 | struct device_attribute delay_attr; | |
b427411a ST |
373 | struct device_attribute enable_attr; |
374 | bool is_enabled; | |
4543d9d7 | 375 | bool is_initialized; |
1ab27c9c | 376 | int active_reqs; |
10e5e375 | 377 | struct workqueue_struct *clk_gating_workq; |
1ab27c9c ST |
378 | }; |
379 | ||
a3cd5ec5 | 380 | struct ufs_saved_pwr_info { |
381 | struct ufs_pa_layer_attr info; | |
382 | bool is_valid; | |
383 | }; | |
384 | ||
401f1e44 | 385 | /** |
386 | * struct ufs_clk_scaling - UFS clock scaling related data | |
387 | * @active_reqs: number of requests that are pending. If this is zero when | |
388 | * devfreq ->target() function is called then schedule "suspend_work" to | |
389 | * suspend devfreq. | |
390 | * @tot_busy_t: Total busy time in current polling window | |
391 | * @window_start_t: Start time (in jiffies) of the current polling window | |
392 | * @busy_start_t: Start time of current busy period | |
393 | * @enable_attr: sysfs attribute to enable/disable clock scaling | |
394 | * @saved_pwr_info: UFS power mode may also be changed during scaling and this | |
395 | * one keeps track of previous power mode. | |
396 | * @workq: workqueue to schedule devfreq suspend/resume work | |
397 | * @suspend_work: worker to suspend devfreq | |
398 | * @resume_work: worker to resume devfreq | |
29b87e92 | 399 | * @min_gear: lowest HS gear to scale down to |
0e9d4ca4 | 400 | * @is_enabled: tracks if scaling is currently enabled or not, controlled by |
cff91daf | 401 | * clkscale_enable sysfs node |
0e9d4ca4 | 402 | * @is_allowed: tracks if scaling is currently allowed or not, used to block |
cff91daf | 403 | * clock scaling which is not invoked from devfreq governor |
4543d9d7 | 404 | * @is_initialized: Indicates whether clock scaling is initialized or not |
401f1e44 | 405 | * @is_busy_started: tracks if busy period has started or not |
406 | * @is_suspended: tracks if devfreq is suspended or not | |
407 | */ | |
856b3483 | 408 | struct ufs_clk_scaling { |
401f1e44 | 409 | int active_reqs; |
410 | unsigned long tot_busy_t; | |
b1bf66d1 | 411 | ktime_t window_start_t; |
401f1e44 | 412 | ktime_t busy_start_t; |
fcb0c4b0 | 413 | struct device_attribute enable_attr; |
a3cd5ec5 | 414 | struct ufs_saved_pwr_info saved_pwr_info; |
401f1e44 | 415 | struct workqueue_struct *workq; |
416 | struct work_struct suspend_work; | |
417 | struct work_struct resume_work; | |
29b87e92 | 418 | u32 min_gear; |
0e9d4ca4 | 419 | bool is_enabled; |
401f1e44 | 420 | bool is_allowed; |
4543d9d7 | 421 | bool is_initialized; |
401f1e44 | 422 | bool is_busy_started; |
423 | bool is_suspended; | |
856b3483 ST |
424 | }; |
425 | ||
e965e5e0 | 426 | #define UFS_EVENT_HIST_LENGTH 8 |
ff8e20c6 | 427 | /** |
e965e5e0 | 428 | * struct ufs_event_hist - keeps history of errors |
ff8e20c6 | 429 | * @pos: index to indicate cyclic buffer position |
cff91daf | 430 | * @val: cyclic buffer for registers value |
ff8e20c6 | 431 | * @tstamp: cyclic buffer for time stamp |
b6cacaf2 | 432 | * @cnt: error counter |
ff8e20c6 | 433 | */ |
e965e5e0 | 434 | struct ufs_event_hist { |
ff8e20c6 | 435 | int pos; |
e965e5e0 | 436 | u32 val[UFS_EVENT_HIST_LENGTH]; |
0f85e747 | 437 | u64 tstamp[UFS_EVENT_HIST_LENGTH]; |
b6cacaf2 | 438 | unsigned long long cnt; |
ff8e20c6 DR |
439 | }; |
440 | ||
441 | /** | |
442 | * struct ufs_stats - keeps usage/err statistics | |
3f8af604 CG |
443 | * @last_intr_status: record the last interrupt status. |
444 | * @last_intr_ts: record the last interrupt timestamp. | |
ff8e20c6 DR |
445 | * @hibern8_exit_cnt: Counter to keep track of number of exits, |
446 | * reset this after link-startup. | |
447 | * @last_hibern8_exit_tstamp: Set time after the hibern8 exit. | |
448 | * Clear after the first successful command completion. | |
cff91daf | 449 | * @event: array with event history. |
ff8e20c6 DR |
450 | */ |
451 | struct ufs_stats { | |
3f8af604 | 452 | u32 last_intr_status; |
0f85e747 | 453 | u64 last_intr_ts; |
3f8af604 | 454 | |
ff8e20c6 | 455 | u32 hibern8_exit_cnt; |
0f85e747 | 456 | u64 last_hibern8_exit_tstamp; |
e965e5e0 | 457 | struct ufs_event_hist event[UFS_EVT_CNT]; |
ff8e20c6 DR |
458 | }; |
459 | ||
9c202090 BVA |
460 | /** |
461 | * enum ufshcd_state - UFS host controller state | |
462 | * @UFSHCD_STATE_RESET: Link is not operational. Postpone SCSI command | |
463 | * processing. | |
464 | * @UFSHCD_STATE_OPERATIONAL: The host controller is operational and can process | |
465 | * SCSI commands. | |
466 | * @UFSHCD_STATE_EH_SCHEDULED_NON_FATAL: The error handler has been scheduled. | |
467 | * SCSI commands may be submitted to the controller. | |
468 | * @UFSHCD_STATE_EH_SCHEDULED_FATAL: The error handler has been scheduled. Fail | |
469 | * newly submitted SCSI commands with error code DID_BAD_TARGET. | |
470 | * @UFSHCD_STATE_ERROR: An unrecoverable error occurred, e.g. link recovery | |
471 | * failed. Fail all SCSI commands with error code DID_ERROR. | |
472 | */ | |
473 | enum ufshcd_state { | |
474 | UFSHCD_STATE_RESET, | |
475 | UFSHCD_STATE_OPERATIONAL, | |
476 | UFSHCD_STATE_EH_SCHEDULED_NON_FATAL, | |
477 | UFSHCD_STATE_EH_SCHEDULED_FATAL, | |
478 | UFSHCD_STATE_ERROR, | |
479 | }; | |
480 | ||
c3f7d1fc CH |
481 | enum ufshcd_quirks { |
482 | /* Interrupt aggregation support is broken */ | |
483 | UFSHCD_QUIRK_BROKEN_INTR_AGGR = 1 << 0, | |
484 | ||
485 | /* | |
486 | * delay before each dme command is required as the unipro | |
487 | * layer has shown instabilities | |
488 | */ | |
489 | UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS = 1 << 1, | |
490 | ||
491 | /* | |
492 | * If UFS host controller is having issue in processing LCC (Line | |
493 | * Control Command) coming from device then enable this quirk. | |
494 | * When this quirk is enabled, host controller driver should disable | |
495 | * the LCC transmission on UFS device (by clearing TX_LCC_ENABLE | |
496 | * attribute of device to 0). | |
497 | */ | |
498 | UFSHCD_QUIRK_BROKEN_LCC = 1 << 2, | |
499 | ||
500 | /* | |
501 | * The attribute PA_RXHSUNTERMCAP specifies whether or not the | |
502 | * inbound Link supports unterminated line in HS mode. Setting this | |
503 | * attribute to 1 fixes moving to HS gear. | |
504 | */ | |
505 | UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP = 1 << 3, | |
506 | ||
507 | /* | |
508 | * This quirk needs to be enabled if the host controller only allows | |
509 | * accessing the peer dme attributes in AUTO mode (FAST AUTO or | |
510 | * SLOW AUTO). | |
511 | */ | |
512 | UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE = 1 << 4, | |
513 | ||
514 | /* | |
515 | * This quirk needs to be enabled if the host controller doesn't | |
516 | * advertise the correct version in UFS_VER register. If this quirk | |
517 | * is enabled, standard UFS host driver will call the vendor specific | |
518 | * ops (get_ufs_hci_version) to get the correct version. | |
519 | */ | |
520 | UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION = 1 << 5, | |
87183841 AA |
521 | |
522 | /* | |
523 | * Clear handling for transfer/task request list is just opposite. | |
524 | */ | |
525 | UFSHCI_QUIRK_BROKEN_REQ_LIST_CLR = 1 << 6, | |
b638b5eb AA |
526 | |
527 | /* | |
528 | * This quirk needs to be enabled if host controller doesn't allow | |
529 | * that the interrupt aggregation timer and counter are reset by s/w. | |
530 | */ | |
531 | UFSHCI_QUIRK_SKIP_RESET_INTR_AGGR = 1 << 7, | |
39bf2d83 AA |
532 | |
533 | /* | |
534 | * This quirks needs to be enabled if host controller cannot be | |
535 | * enabled via HCE register. | |
536 | */ | |
537 | UFSHCI_QUIRK_BROKEN_HCE = 1 << 8, | |
26f968d7 AA |
538 | |
539 | /* | |
540 | * This quirk needs to be enabled if the host controller regards | |
541 | * resolution of the values of PRDTO and PRDTL in UTRD as byte. | |
542 | */ | |
543 | UFSHCD_QUIRK_PRDT_BYTE_GRAN = 1 << 9, | |
d779a6e9 KK |
544 | |
545 | /* | |
546 | * This quirk needs to be enabled if the host controller reports | |
547 | * OCS FATAL ERROR with device error through sense data | |
548 | */ | |
549 | UFSHCD_QUIRK_BROKEN_OCS_FATAL_ERROR = 1 << 10, | |
5df6f2de | 550 | |
8da76f71 AH |
551 | /* |
552 | * This quirk needs to be enabled if the host controller has | |
553 | * auto-hibernate capability but it doesn't work. | |
554 | */ | |
555 | UFSHCD_QUIRK_BROKEN_AUTO_HIBERN8 = 1 << 11, | |
02f74150 | 556 | |
5df6f2de KK |
557 | /* |
558 | * This quirk needs to disable manual flush for write booster | |
559 | */ | |
02f74150 MP |
560 | UFSHCI_QUIRK_SKIP_MANUAL_WB_FLUSH_CTRL = 1 << 12, |
561 | ||
b1d0d2eb KK |
562 | /* |
563 | * This quirk needs to disable unipro timeout values | |
564 | * before power mode change | |
565 | */ | |
566 | UFSHCD_QUIRK_SKIP_DEF_UNIPRO_TIMEOUT_SETTING = 1 << 13, | |
567 | ||
2b2bfc8a KK |
568 | /* |
569 | * This quirk allows only sg entries aligned with page size. | |
570 | */ | |
9599a1cf | 571 | UFSHCD_QUIRK_ALIGN_SG_WITH_PAGE_SIZE = 1 << 14, |
a22bcfdb | 572 | |
573 | /* | |
574 | * This quirk needs to be enabled if the host controller does not | |
575 | * support UIC command | |
576 | */ | |
577 | UFSHCD_QUIRK_BROKEN_UIC_CMD = 1 << 15, | |
10fb4f87 | 578 | |
579 | /* | |
580 | * This quirk needs to be enabled if the host controller cannot | |
581 | * support physical host configuration. | |
582 | */ | |
583 | UFSHCD_QUIRK_SKIP_PH_CONFIGURATION = 1 << 16, | |
6554400d YS |
584 | |
585 | /* | |
586 | * This quirk needs to be enabled if the host controller has | |
587 | * 64-bit addressing supported capability but it doesn't work. | |
588 | */ | |
589 | UFSHCD_QUIRK_BROKEN_64BIT_ADDRESS = 1 << 17, | |
2f11bbc2 YS |
590 | |
591 | /* | |
592 | * This quirk needs to be enabled if the host controller has | |
593 | * auto-hibernate capability but it's FASTAUTO only. | |
594 | */ | |
595 | UFSHCD_QUIRK_HIBERN_FASTAUTO = 1 << 18, | |
c3f7d1fc CH |
596 | }; |
597 | ||
c2014682 SC |
598 | enum ufshcd_caps { |
599 | /* Allow dynamic clk gating */ | |
600 | UFSHCD_CAP_CLK_GATING = 1 << 0, | |
601 | ||
602 | /* Allow hiberb8 with clk gating */ | |
603 | UFSHCD_CAP_HIBERN8_WITH_CLK_GATING = 1 << 1, | |
604 | ||
605 | /* Allow dynamic clk scaling */ | |
606 | UFSHCD_CAP_CLK_SCALING = 1 << 2, | |
607 | ||
608 | /* Allow auto bkops to enabled during runtime suspend */ | |
609 | UFSHCD_CAP_AUTO_BKOPS_SUSPEND = 1 << 3, | |
610 | ||
611 | /* | |
612 | * This capability allows host controller driver to use the UFS HCI's | |
613 | * interrupt aggregation capability. | |
614 | * CAUTION: Enabling this might reduce overall UFS throughput. | |
615 | */ | |
616 | UFSHCD_CAP_INTR_AGGR = 1 << 4, | |
617 | ||
618 | /* | |
619 | * This capability allows the device auto-bkops to be always enabled | |
620 | * except during suspend (both runtime and suspend). | |
621 | * Enabling this capability means that device will always be allowed | |
622 | * to do background operation when it's active but it might degrade | |
623 | * the performance of ongoing read/write operations. | |
624 | */ | |
625 | UFSHCD_CAP_KEEP_AUTO_BKOPS_ENABLED_EXCEPT_SUSPEND = 1 << 5, | |
626 | ||
627 | /* | |
628 | * This capability allows host controller driver to automatically | |
629 | * enable runtime power management by itself instead of waiting | |
630 | * for userspace to control the power management. | |
631 | */ | |
632 | UFSHCD_CAP_RPM_AUTOSUSPEND = 1 << 6, | |
3d17b9b5 AD |
633 | |
634 | /* | |
635 | * This capability allows the host controller driver to turn-on | |
636 | * WriteBooster, if the underlying device supports it and is | |
637 | * provisioned to be used. This would increase the write performance. | |
638 | */ | |
639 | UFSHCD_CAP_WB_EN = 1 << 7, | |
5e7341e1 ST |
640 | |
641 | /* | |
642 | * This capability allows the host controller driver to use the | |
643 | * inline crypto engine, if it is present | |
644 | */ | |
645 | UFSHCD_CAP_CRYPTO = 1 << 8, | |
dd7143e2 CG |
646 | |
647 | /* | |
648 | * This capability allows the controller regulators to be put into | |
649 | * lpm mode aggressively during clock gating. | |
650 | * This would increase power savings. | |
651 | */ | |
652 | UFSHCD_CAP_AGGR_POWER_COLLAPSE = 1 << 9, | |
fe1d4c2e AH |
653 | |
654 | /* | |
655 | * This capability allows the host controller driver to use DeepSleep, | |
656 | * if it is supported by the UFS device. The host controller driver must | |
657 | * support device hardware reset via the hba->device_reset() callback, | |
658 | * in order to exit DeepSleep state. | |
659 | */ | |
660 | UFSHCD_CAP_DEEPSLEEP = 1 << 10, | |
e88e2d32 AA |
661 | |
662 | /* | |
663 | * This capability allows the host controller driver to use temperature | |
664 | * notification if it is supported by the UFS device. | |
665 | */ | |
666 | UFSHCD_CAP_TEMP_NOTIF = 1 << 11, | |
87bd0501 PW |
667 | |
668 | /* | |
669 | * Enable WriteBooster when scaling up the clock and disable | |
670 | * WriteBooster when scaling the clock down. | |
671 | */ | |
672 | UFSHCD_CAP_WB_WITH_CLK_SCALING = 1 << 12, | |
c2014682 SC |
673 | }; |
674 | ||
90b8491c SC |
675 | struct ufs_hba_variant_params { |
676 | struct devfreq_dev_profile devfreq_profile; | |
677 | struct devfreq_simple_ondemand_data ondemand_data; | |
678 | u16 hba_enable_delay_us; | |
d14734ae | 679 | u32 wb_flush_threshold; |
90b8491c SC |
680 | }; |
681 | ||
f02bc975 DP |
682 | #ifdef CONFIG_SCSI_UFS_HPB |
683 | /** | |
684 | * struct ufshpb_dev_info - UFSHPB device related info | |
685 | * @num_lu: the number of user logical unit to check whether all lu finished | |
686 | * initialization | |
687 | * @rgn_size: device reported HPB region size | |
688 | * @srgn_size: device reported HPB sub-region size | |
689 | * @slave_conf_cnt: counter to check all lu finished initialization | |
690 | * @hpb_disabled: flag to check if HPB is disabled | |
41d8a933 DP |
691 | * @max_hpb_single_cmd: device reported bMAX_DATA_SIZE_FOR_SINGLE_CMD value |
692 | * @is_legacy: flag to check HPB 1.0 | |
119ee38c | 693 | * @control_mode: either host or device |
f02bc975 DP |
694 | */ |
695 | struct ufshpb_dev_info { | |
696 | int num_lu; | |
697 | int rgn_size; | |
698 | int srgn_size; | |
699 | atomic_t slave_conf_cnt; | |
700 | bool hpb_disabled; | |
41d8a933 DP |
701 | u8 max_hpb_single_cmd; |
702 | bool is_legacy; | |
119ee38c | 703 | u8 control_mode; |
f02bc975 DP |
704 | }; |
705 | #endif | |
706 | ||
1d8613a2 CG |
707 | struct ufs_hba_monitor { |
708 | unsigned long chunk_size; | |
709 | ||
710 | unsigned long nr_sec_rw[2]; | |
711 | ktime_t total_busy[2]; | |
712 | ||
713 | unsigned long nr_req[2]; | |
714 | /* latencies*/ | |
715 | ktime_t lat_sum[2]; | |
716 | ktime_t lat_max[2]; | |
717 | ktime_t lat_min[2]; | |
718 | ||
719 | u32 nr_queued[2]; | |
720 | ktime_t busy_start_ts[2]; | |
721 | ||
722 | ktime_t enabled_ts; | |
723 | bool enabled; | |
724 | }; | |
725 | ||
e0eca63e VH |
726 | /** |
727 | * struct ufs_hba - per adapter private structure | |
728 | * @mmio_base: UFSHCI base register address | |
729 | * @ucdl_base_addr: UFS Command Descriptor base address | |
730 | * @utrdl_base_addr: UTP Transfer Request Descriptor base address | |
731 | * @utmrdl_base_addr: UTP Task Management Descriptor base address | |
732 | * @ucdl_dma_addr: UFS Command Descriptor DMA address | |
733 | * @utrdl_dma_addr: UTRDL DMA address | |
734 | * @utmrdl_dma_addr: UTMRDL DMA address | |
735 | * @host: Scsi_Host instance of the driver | |
736 | * @dev: device handle | |
e2106584 | 737 | * @ufs_device_wlun: WLUN that controls the entire UFS device. |
cff91daf BVA |
738 | * @hwmon_device: device instance registered with the hwmon core. |
739 | * @curr_dev_pwr_mode: active UFS device power mode. | |
740 | * @uic_link_state: active state of the link to the UFS device. | |
741 | * @rpm_lvl: desired UFS power management level during runtime PM. | |
742 | * @spm_lvl: desired UFS power management level during system PM. | |
743 | * @pm_op_in_progress: whether or not a PM operation is in progress. | |
744 | * @ahit: value of Auto-Hibernate Idle Timer register. | |
e0eca63e VH |
745 | * @lrb: local reference block |
746 | * @outstanding_tasks: Bits representing outstanding task requests | |
169f5eb2 | 747 | * @outstanding_lock: Protects @outstanding_reqs. |
e0eca63e VH |
748 | * @outstanding_reqs: Bits representing outstanding transfer requests |
749 | * @capabilities: UFS Controller Capabilities | |
750 | * @nutrs: Transfer Request Queue depth supported by controller | |
751 | * @nutmrs: Task Management Queue depth supported by controller | |
945c3cca | 752 | * @reserved_slot: Used to submit device commands. Protected by @dev_cmd.lock. |
e0eca63e | 753 | * @ufs_version: UFS Version to which controller complies |
5c0c28a8 | 754 | * @vops: pointer to variant specific operations |
cff91daf | 755 | * @vps: pointer to variant specific parameters |
5c0c28a8 | 756 | * @priv: pointer to variant specific private data |
e0eca63e | 757 | * @irq: Irq number of the controller |
cff91daf BVA |
758 | * @is_irq_enabled: whether or not the UFS controller interrupt is enabled. |
759 | * @dev_ref_clk_freq: reference clock frequency | |
760 | * @quirks: bitmask with information about deviations from the UFSHCI standard. | |
761 | * @dev_quirks: bitmask with information about deviations from the UFS standard. | |
69a6c269 BVA |
762 | * @tmf_tag_set: TMF tag set. |
763 | * @tmf_queue: Used to allocate TMF tags. | |
cff91daf BVA |
764 | * @tmf_rqs: array with pointers to TMF requests while these are in progress. |
765 | * @active_uic_cmd: handle of active UIC command | |
766 | * @uic_cmd_mutex: mutex for UIC command | |
767 | * @uic_async_done: completion used during UIC processing | |
9c202090 | 768 | * @ufshcd_state: UFSHCD state |
3441da7d | 769 | * @eh_flags: Error handling flags |
2fbd009b | 770 | * @intr_mask: Interrupt Mask Bits |
66ec6d59 | 771 | * @ee_ctrl_mask: Exception event control mask |
cff91daf BVA |
772 | * @ee_drv_mask: Exception event mask for driver |
773 | * @ee_usr_mask: Exception event mask for user (set via debugfs) | |
774 | * @ee_ctrl_mutex: Used to serialize exception event information. | |
1d337ec2 | 775 | * @is_powered: flag to check if HBA is powered |
9cd20d3f CG |
776 | * @shutting_down: flag to check if shutdown has been invoked |
777 | * @host_sem: semaphore used to serialize concurrent contexts | |
88b09900 AH |
778 | * @eh_wq: Workqueue that eh_work works on |
779 | * @eh_work: Worker to handle UFS errors that require s/w attention | |
66ec6d59 | 780 | * @eeh_work: Worker to handle exception events |
e0eca63e | 781 | * @errors: HBA errors |
e8e7f271 SRT |
782 | * @uic_error: UFS interconnect layer error status |
783 | * @saved_err: sticky error mask | |
784 | * @saved_uic_err: sticky UIC error mask | |
cff91daf | 785 | * @ufs_stats: various error counters |
4db7a236 | 786 | * @force_reset: flag to force eh_work perform a full reset |
2355b66e | 787 | * @force_pmc: flag to force a power mode change |
2df74b69 | 788 | * @silence_err_logs: flag to silence error logs |
5a0b0cb9 | 789 | * @dev_cmd: ufs device management command information |
cad2e03d | 790 | * @last_dme_cmd_tstamp: time stamp of the last completed DME command |
cff91daf BVA |
791 | * @nop_out_timeout: NOP OUT timeout value |
792 | * @dev_info: information about the UFS device | |
66ec6d59 | 793 | * @auto_bkops_enabled: to track whether bkops is enabled in device |
aa497613 | 794 | * @vreg_info: UFS device voltage regulator information |
c6e79dac | 795 | * @clk_list_head: UFS host controller clocks list node head |
cff91daf BVA |
796 | * @req_abort_count: number of times ufshcd_abort() has been called |
797 | * @lanes_per_direction: number of lanes per data direction between the UFS | |
798 | * controller and the UFS device. | |
7eb584db DR |
799 | * @pwr_info: holds current power mode |
800 | * @max_pwr_info: keeps the device max valid pwm | |
cff91daf BVA |
801 | * @clk_gating: information related to clock gating |
802 | * @caps: bitmask with information about UFS controller capabilities | |
803 | * @devfreq: frequency scaling information owned by the devfreq core | |
804 | * @clk_scaling: frequency scaling information owned by the UFS driver | |
1a547cbc BVA |
805 | * @system_suspending: system suspend has been started and system resume has |
806 | * not yet finished. | |
807 | * @is_sys_suspended: UFS device has been suspended because of system suspend | |
afdfff59 YG |
808 | * @urgent_bkops_lvl: keeps track of urgent bkops level for device |
809 | * @is_urgent_bkops_lvl_checked: keeps track if the urgent bkops level for | |
810 | * device is known or not. | |
cff91daf BVA |
811 | * @clk_scaling_lock: used to serialize device commands and clock scaling |
812 | * @desc_size: descriptor sizes reported by device | |
38135535 | 813 | * @scsi_block_reqs_cnt: reference counting for scsi block requests |
cff91daf BVA |
814 | * @bsg_dev: struct device associated with the BSG queue |
815 | * @bsg_queue: BSG queue associated with the UFS controller | |
816 | * @rpm_dev_flush_recheck_work: used to suspend from RPM (runtime power | |
817 | * management) after the UFS device has finished a WriteBooster buffer | |
818 | * flush or auto BKOP. | |
819 | * @ufshpb_dev: information related to HPB (Host Performance Booster). | |
820 | * @monitor: statistics about UFS commands | |
70297a8a ST |
821 | * @crypto_capabilities: Content of crypto capabilities register (0x100) |
822 | * @crypto_cap_array: Array of crypto capabilities | |
823 | * @crypto_cfg_register: Start of the crypto cfg array | |
cb77cb5a | 824 | * @crypto_profile: the crypto profile of this hba (if applicable) |
cff91daf BVA |
825 | * @debugfs_root: UFS controller debugfs root directory |
826 | * @debugfs_ee_work: used to restore ee_ctrl_mask after a delay | |
827 | * @debugfs_ee_rate_limit_ms: user configurable delay after which to restore | |
828 | * ee_ctrl_mask | |
829 | * @luns_avail: number of regular and well known LUNs supported by the UFS | |
830 | * device | |
831 | * @complete_put: whether or not to call ufshcd_rpm_put() from inside | |
832 | * ufshcd_resume_complete() | |
e0eca63e VH |
833 | */ |
834 | struct ufs_hba { | |
835 | void __iomem *mmio_base; | |
836 | ||
837 | /* Virtual memory reference */ | |
838 | struct utp_transfer_cmd_desc *ucdl_base_addr; | |
839 | struct utp_transfer_req_desc *utrdl_base_addr; | |
840 | struct utp_task_req_desc *utmrdl_base_addr; | |
841 | ||
842 | /* DMA memory reference */ | |
843 | dma_addr_t ucdl_dma_addr; | |
844 | dma_addr_t utrdl_dma_addr; | |
845 | dma_addr_t utmrdl_dma_addr; | |
846 | ||
847 | struct Scsi_Host *host; | |
848 | struct device *dev; | |
e2106584 | 849 | struct scsi_device *ufs_device_wlun; |
e0eca63e | 850 | |
e88e2d32 AA |
851 | #ifdef CONFIG_SCSI_UFS_HWMON |
852 | struct device *hwmon_device; | |
853 | #endif | |
854 | ||
57d104c1 SJ |
855 | enum ufs_dev_pwr_mode curr_dev_pwr_mode; |
856 | enum uic_link_state uic_link_state; | |
857 | /* Desired UFS power management level during runtime PM */ | |
858 | enum ufs_pm_level rpm_lvl; | |
859 | /* Desired UFS power management level during system PM */ | |
860 | enum ufs_pm_level spm_lvl; | |
861 | int pm_op_in_progress; | |
862 | ||
ad448378 AH |
863 | /* Auto-Hibernate Idle Timer register value */ |
864 | u32 ahit; | |
865 | ||
e0eca63e VH |
866 | struct ufshcd_lrb *lrb; |
867 | ||
868 | unsigned long outstanding_tasks; | |
169f5eb2 | 869 | spinlock_t outstanding_lock; |
e0eca63e VH |
870 | unsigned long outstanding_reqs; |
871 | ||
872 | u32 capabilities; | |
873 | int nutrs; | |
874 | int nutmrs; | |
945c3cca | 875 | u32 reserved_slot; |
e0eca63e | 876 | u32 ufs_version; |
176eb927 | 877 | const struct ufs_hba_variant_ops *vops; |
90b8491c | 878 | struct ufs_hba_variant_params *vps; |
5c0c28a8 | 879 | void *priv; |
e0eca63e | 880 | unsigned int irq; |
57d104c1 | 881 | bool is_irq_enabled; |
9e1e8a75 | 882 | enum ufs_ref_clk_freq dev_ref_clk_freq; |
e0eca63e | 883 | |
cad2e03d | 884 | unsigned int quirks; /* Deviations from standard UFSHCI spec. */ |
6ccf44fe | 885 | |
c58ab7aa YG |
886 | /* Device deviations from standard UFS device spec. */ |
887 | unsigned int dev_quirks; | |
888 | ||
69a6c269 BVA |
889 | struct blk_mq_tag_set tmf_tag_set; |
890 | struct request_queue *tmf_queue; | |
f5ef336f | 891 | struct request **tmf_rqs; |
e0eca63e | 892 | |
57d104c1 SJ |
893 | struct uic_command *active_uic_cmd; |
894 | struct mutex uic_cmd_mutex; | |
895 | struct completion *uic_async_done; | |
53b3d9c3 | 896 | |
9c202090 | 897 | enum ufshcd_state ufshcd_state; |
3441da7d | 898 | u32 eh_flags; |
2fbd009b | 899 | u32 intr_mask; |
cff91daf BVA |
900 | u16 ee_ctrl_mask; |
901 | u16 ee_drv_mask; | |
902 | u16 ee_usr_mask; | |
cd469475 | 903 | struct mutex ee_ctrl_mutex; |
1d337ec2 | 904 | bool is_powered; |
9cd20d3f CG |
905 | bool shutting_down; |
906 | struct semaphore host_sem; | |
e0eca63e VH |
907 | |
908 | /* Work Queues */ | |
88b09900 AH |
909 | struct workqueue_struct *eh_wq; |
910 | struct work_struct eh_work; | |
66ec6d59 | 911 | struct work_struct eeh_work; |
e0eca63e VH |
912 | |
913 | /* HBA Errors */ | |
914 | u32 errors; | |
e8e7f271 SRT |
915 | u32 uic_error; |
916 | u32 saved_err; | |
917 | u32 saved_uic_err; | |
ff8e20c6 | 918 | struct ufs_stats ufs_stats; |
4db7a236 | 919 | bool force_reset; |
2355b66e | 920 | bool force_pmc; |
2df74b69 | 921 | bool silence_err_logs; |
5a0b0cb9 SRT |
922 | |
923 | /* Device management request data */ | |
924 | struct ufs_dev_cmd dev_cmd; | |
cad2e03d | 925 | ktime_t last_dme_cmd_tstamp; |
1cbc9ad3 | 926 | int nop_out_timeout; |
66ec6d59 | 927 | |
57d104c1 SJ |
928 | /* Keeps information of the UFS device connected to this host */ |
929 | struct ufs_dev_info dev_info; | |
66ec6d59 | 930 | bool auto_bkops_enabled; |
aa497613 | 931 | struct ufs_vreg_info vreg_info; |
c6e79dac | 932 | struct list_head clk_list_head; |
57d104c1 | 933 | |
7fabb77b GB |
934 | /* Number of requests aborts */ |
935 | int req_abort_count; | |
936 | ||
54b879b7 YG |
937 | /* Number of lanes available (1 or 2) for Rx/Tx */ |
938 | u32 lanes_per_direction; | |
7eb584db DR |
939 | struct ufs_pa_layer_attr pwr_info; |
940 | struct ufs_pwr_mode_info max_pwr_info; | |
1ab27c9c ST |
941 | |
942 | struct ufs_clk_gating clk_gating; | |
943 | /* Control to enable/disable host capabilities */ | |
944 | u32 caps; | |
856b3483 ST |
945 | |
946 | struct devfreq *devfreq; | |
947 | struct ufs_clk_scaling clk_scaling; | |
1a547cbc | 948 | bool system_suspending; |
e785060e | 949 | bool is_sys_suspended; |
afdfff59 YG |
950 | |
951 | enum bkops_status urgent_bkops_lvl; | |
952 | bool is_urgent_bkops_lvl_checked; | |
a3cd5ec5 | 953 | |
954 | struct rw_semaphore clk_scaling_lock; | |
7a0bf85b | 955 | unsigned char desc_size[QUERY_DESC_IDN_MAX]; |
38135535 | 956 | atomic_t scsi_block_reqs_cnt; |
df032bf2 AA |
957 | |
958 | struct device bsg_dev; | |
959 | struct request_queue *bsg_queue; | |
51dd905b | 960 | struct delayed_work rpm_dev_flush_recheck_work; |
70297a8a | 961 | |
f02bc975 DP |
962 | #ifdef CONFIG_SCSI_UFS_HPB |
963 | struct ufshpb_dev_info ufshpb_dev; | |
964 | #endif | |
965 | ||
1d8613a2 CG |
966 | struct ufs_hba_monitor monitor; |
967 | ||
70297a8a ST |
968 | #ifdef CONFIG_SCSI_UFS_CRYPTO |
969 | union ufs_crypto_capabilities crypto_capabilities; | |
970 | union ufs_crypto_cap_entry *crypto_cap_array; | |
971 | u32 crypto_cfg_register; | |
cb77cb5a | 972 | struct blk_crypto_profile crypto_profile; |
70297a8a | 973 | #endif |
b6cacaf2 AH |
974 | #ifdef CONFIG_DEBUG_FS |
975 | struct dentry *debugfs_root; | |
7deedfda AH |
976 | struct delayed_work debugfs_ee_work; |
977 | u32 debugfs_ee_rate_limit_ms; | |
b6cacaf2 | 978 | #endif |
b294ff3e AD |
979 | u32 luns_avail; |
980 | bool complete_put; | |
e0eca63e VH |
981 | }; |
982 | ||
1ab27c9c ST |
983 | /* Returns true if clocks can be gated. Otherwise false */ |
984 | static inline bool ufshcd_is_clkgating_allowed(struct ufs_hba *hba) | |
985 | { | |
986 | return hba->caps & UFSHCD_CAP_CLK_GATING; | |
987 | } | |
988 | static inline bool ufshcd_can_hibern8_during_gating(struct ufs_hba *hba) | |
989 | { | |
990 | return hba->caps & UFSHCD_CAP_HIBERN8_WITH_CLK_GATING; | |
991 | } | |
fcb0c4b0 | 992 | static inline int ufshcd_is_clkscaling_supported(struct ufs_hba *hba) |
856b3483 ST |
993 | { |
994 | return hba->caps & UFSHCD_CAP_CLK_SCALING; | |
995 | } | |
374a246e SJ |
996 | static inline bool ufshcd_can_autobkops_during_suspend(struct ufs_hba *hba) |
997 | { | |
998 | return hba->caps & UFSHCD_CAP_AUTO_BKOPS_SUSPEND; | |
999 | } | |
49615ba1 SC |
1000 | static inline bool ufshcd_is_rpm_autosuspend_allowed(struct ufs_hba *hba) |
1001 | { | |
1002 | return hba->caps & UFSHCD_CAP_RPM_AUTOSUSPEND; | |
1003 | } | |
374a246e | 1004 | |
b852190e YG |
1005 | static inline bool ufshcd_is_intr_aggr_allowed(struct ufs_hba *hba) |
1006 | { | |
1c0810e7 KP |
1007 | return (hba->caps & UFSHCD_CAP_INTR_AGGR) && |
1008 | !(hba->quirks & UFSHCD_QUIRK_BROKEN_INTR_AGGR); | |
b852190e YG |
1009 | } |
1010 | ||
dd7143e2 CG |
1011 | static inline bool ufshcd_can_aggressive_pc(struct ufs_hba *hba) |
1012 | { | |
1013 | return !!(ufshcd_is_link_hibern8(hba) && | |
1014 | (hba->caps & UFSHCD_CAP_AGGR_POWER_COLLAPSE)); | |
1015 | } | |
1016 | ||
ee5f1042 SC |
1017 | static inline bool ufshcd_is_auto_hibern8_supported(struct ufs_hba *hba) |
1018 | { | |
8da76f71 AH |
1019 | return (hba->capabilities & MASK_AUTO_HIBERN8_SUPPORT) && |
1020 | !(hba->quirks & UFSHCD_QUIRK_BROKEN_AUTO_HIBERN8); | |
ee5f1042 SC |
1021 | } |
1022 | ||
5a244e0e SC |
1023 | static inline bool ufshcd_is_auto_hibern8_enabled(struct ufs_hba *hba) |
1024 | { | |
51d1628f | 1025 | return FIELD_GET(UFSHCI_AHIBERN8_TIMER_MASK, hba->ahit); |
5a244e0e SC |
1026 | } |
1027 | ||
3d17b9b5 AD |
1028 | static inline bool ufshcd_is_wb_allowed(struct ufs_hba *hba) |
1029 | { | |
1030 | return hba->caps & UFSHCD_CAP_WB_EN; | |
1031 | } | |
1032 | ||
87bd0501 PW |
1033 | static inline bool ufshcd_enable_wb_if_scaling_up(struct ufs_hba *hba) |
1034 | { | |
1035 | return hba->caps & UFSHCD_CAP_WB_WITH_CLK_SCALING; | |
1036 | } | |
1037 | ||
b873a275 SJ |
1038 | #define ufshcd_writel(hba, val, reg) \ |
1039 | writel((val), (hba)->mmio_base + (reg)) | |
1040 | #define ufshcd_readl(hba, reg) \ | |
1041 | readl((hba)->mmio_base + (reg)) | |
1042 | ||
e785060e | 1043 | /** |
cff91daf BVA |
1044 | * ufshcd_rmwl - perform read/modify/write for a controller register |
1045 | * @hba: per adapter instance | |
1046 | * @mask: mask to apply on read value | |
1047 | * @val: actual value to write | |
1048 | * @reg: register address | |
e785060e DR |
1049 | */ |
1050 | static inline void ufshcd_rmwl(struct ufs_hba *hba, u32 mask, u32 val, u32 reg) | |
1051 | { | |
1052 | u32 tmp; | |
1053 | ||
1054 | tmp = ufshcd_readl(hba, reg); | |
1055 | tmp &= ~mask; | |
1056 | tmp |= (val & mask); | |
1057 | ufshcd_writel(hba, tmp, reg); | |
1058 | } | |
1059 | ||
5c0c28a8 | 1060 | int ufshcd_alloc_host(struct device *, struct ufs_hba **); |
47555a5c | 1061 | void ufshcd_dealloc_host(struct ufs_hba *); |
9d19bf7a | 1062 | int ufshcd_hba_enable(struct ufs_hba *hba); |
ecd7beb3 | 1063 | int ufshcd_init(struct ufs_hba *, void __iomem *, unsigned int); |
087c5efa | 1064 | int ufshcd_link_recovery(struct ufs_hba *hba); |
9d19bf7a | 1065 | int ufshcd_make_hba_operational(struct ufs_hba *hba); |
e0eca63e | 1066 | void ufshcd_remove(struct ufs_hba *); |
525943a5 | 1067 | int ufshcd_uic_hibern8_enter(struct ufs_hba *hba); |
9d19bf7a | 1068 | int ufshcd_uic_hibern8_exit(struct ufs_hba *hba); |
5c955c10 | 1069 | void ufshcd_delay_us(unsigned long us, unsigned long tolerance); |
9e1e8a75 | 1070 | void ufshcd_parse_dev_ref_clk_freq(struct ufs_hba *hba, struct clk *refclk); |
e965e5e0 | 1071 | void ufshcd_update_evt_hist(struct ufs_hba *hba, u32 id, u32 val); |
3a95f5b3 | 1072 | void ufshcd_hba_stop(struct ufs_hba *hba); |
267a59f6 | 1073 | void ufshcd_schedule_eh_work(struct ufs_hba *hba); |
e0eca63e | 1074 | |
1ce5898a YG |
1075 | /** |
1076 | * ufshcd_set_variant - set variant specific data to the hba | |
cff91daf BVA |
1077 | * @hba: per adapter instance |
1078 | * @variant: pointer to variant specific data | |
1ce5898a YG |
1079 | */ |
1080 | static inline void ufshcd_set_variant(struct ufs_hba *hba, void *variant) | |
1081 | { | |
1082 | BUG_ON(!hba); | |
1083 | hba->priv = variant; | |
1084 | } | |
1085 | ||
1086 | /** | |
1087 | * ufshcd_get_variant - get variant specific data from the hba | |
cff91daf | 1088 | * @hba: per adapter instance |
1ce5898a YG |
1089 | */ |
1090 | static inline void *ufshcd_get_variant(struct ufs_hba *hba) | |
1091 | { | |
1092 | BUG_ON(!hba); | |
1093 | return hba->priv; | |
1094 | } | |
e88e2d32 | 1095 | |
9bb25e5d | 1096 | #ifdef CONFIG_PM |
f1ecbe1e BVA |
1097 | extern int ufshcd_runtime_suspend(struct device *dev); |
1098 | extern int ufshcd_runtime_resume(struct device *dev); | |
9bb25e5d BVA |
1099 | #endif |
1100 | #ifdef CONFIG_PM_SLEEP | |
f1ecbe1e BVA |
1101 | extern int ufshcd_system_suspend(struct device *dev); |
1102 | extern int ufshcd_system_resume(struct device *dev); | |
9bb25e5d | 1103 | #endif |
57d104c1 | 1104 | extern int ufshcd_shutdown(struct ufs_hba *hba); |
fc85a74e SC |
1105 | extern int ufshcd_dme_configure_adapt(struct ufs_hba *hba, |
1106 | int agreed_gear, | |
1107 | int adapt_val); | |
12b4fdb4 SJ |
1108 | extern int ufshcd_dme_set_attr(struct ufs_hba *hba, u32 attr_sel, |
1109 | u8 attr_set, u32 mib_val, u8 peer); | |
1110 | extern int ufshcd_dme_get_attr(struct ufs_hba *hba, u32 attr_sel, | |
1111 | u32 *mib_val, u8 peer); | |
0d846e70 AA |
1112 | extern int ufshcd_config_pwr_mode(struct ufs_hba *hba, |
1113 | struct ufs_pa_layer_attr *desired_pwr_mode); | |
fc53683b | 1114 | extern int ufshcd_uic_change_pwr_mode(struct ufs_hba *hba, u8 mode); |
12b4fdb4 SJ |
1115 | |
1116 | /* UIC command interfaces for DME primitives */ | |
1117 | #define DME_LOCAL 0 | |
1118 | #define DME_PEER 1 | |
1119 | #define ATTR_SET_NOR 0 /* NORMAL */ | |
1120 | #define ATTR_SET_ST 1 /* STATIC */ | |
1121 | ||
1122 | static inline int ufshcd_dme_set(struct ufs_hba *hba, u32 attr_sel, | |
1123 | u32 mib_val) | |
1124 | { | |
1125 | return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR, | |
1126 | mib_val, DME_LOCAL); | |
1127 | } | |
1128 | ||
1129 | static inline int ufshcd_dme_st_set(struct ufs_hba *hba, u32 attr_sel, | |
1130 | u32 mib_val) | |
1131 | { | |
1132 | return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST, | |
1133 | mib_val, DME_LOCAL); | |
1134 | } | |
1135 | ||
1136 | static inline int ufshcd_dme_peer_set(struct ufs_hba *hba, u32 attr_sel, | |
1137 | u32 mib_val) | |
1138 | { | |
1139 | return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR, | |
1140 | mib_val, DME_PEER); | |
1141 | } | |
1142 | ||
1143 | static inline int ufshcd_dme_peer_st_set(struct ufs_hba *hba, u32 attr_sel, | |
1144 | u32 mib_val) | |
1145 | { | |
1146 | return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST, | |
1147 | mib_val, DME_PEER); | |
1148 | } | |
1149 | ||
1150 | static inline int ufshcd_dme_get(struct ufs_hba *hba, | |
1151 | u32 attr_sel, u32 *mib_val) | |
1152 | { | |
1153 | return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_LOCAL); | |
1154 | } | |
1155 | ||
1156 | static inline int ufshcd_dme_peer_get(struct ufs_hba *hba, | |
1157 | u32 attr_sel, u32 *mib_val) | |
1158 | { | |
1159 | return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_PEER); | |
1160 | } | |
1161 | ||
f37aabcf YG |
1162 | static inline bool ufshcd_is_hs_mode(struct ufs_pa_layer_attr *pwr_info) |
1163 | { | |
1164 | return (pwr_info->pwr_rx == FAST_MODE || | |
1165 | pwr_info->pwr_rx == FASTAUTO_MODE) && | |
1166 | (pwr_info->pwr_tx == FAST_MODE || | |
1167 | pwr_info->pwr_tx == FASTAUTO_MODE); | |
1168 | } | |
1169 | ||
984eaac1 SC |
1170 | static inline int ufshcd_disable_host_tx_lcc(struct ufs_hba *hba) |
1171 | { | |
1172 | return ufshcd_dme_set(hba, UIC_ARG_MIB(PA_LOCAL_TX_LCC_ENABLE), 0); | |
1173 | } | |
1174 | ||
71d848b8 | 1175 | void ufshcd_auto_hibern8_enable(struct ufs_hba *hba); |
ba7af5ec | 1176 | void ufshcd_auto_hibern8_update(struct ufs_hba *hba, u32 ahit); |
aead21f3 BVA |
1177 | void ufshcd_fixup_dev_quirks(struct ufs_hba *hba, |
1178 | const struct ufs_dev_quirk *fixups); | |
4b828fe1 TW |
1179 | #define SD_ASCII_STD true |
1180 | #define SD_RAW false | |
1181 | int ufshcd_read_string_desc(struct ufs_hba *hba, u8 desc_index, | |
1182 | u8 **buf, bool ascii); | |
2238d31c | 1183 | |
1ab27c9c ST |
1184 | int ufshcd_hold(struct ufs_hba *hba, bool async); |
1185 | void ufshcd_release(struct ufs_hba *hba); | |
a4b0e8a4 | 1186 | |
ad8a647e BVA |
1187 | void ufshcd_clkgate_delay_set(struct device *dev, unsigned long value); |
1188 | ||
7a0bf85b BH |
1189 | void ufshcd_map_desc_id_to_length(struct ufs_hba *hba, enum desc_idn desc_id, |
1190 | int *desc_length); | |
a4b0e8a4 | 1191 | |
37113106 | 1192 | u32 ufshcd_get_local_unipro_ver(struct ufs_hba *hba); |
0263bcd0 | 1193 | |
1d6f9dec SC |
1194 | int ufshcd_get_vreg(struct device *dev, struct ufs_vreg *vreg); |
1195 | ||
e77044c5 AA |
1196 | int ufshcd_send_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd); |
1197 | ||
5e0a86ee AA |
1198 | int ufshcd_exec_raw_upiu_cmd(struct ufs_hba *hba, |
1199 | struct utp_upiu_req *req_upiu, | |
1200 | struct utp_upiu_req *rsp_upiu, | |
1201 | int msgcode, | |
1202 | u8 *desc_buff, int *buff_len, | |
1203 | enum query_opcode desc_op); | |
1204 | ||
3b5f3c0d | 1205 | int ufshcd_wb_toggle(struct ufs_hba *hba, bool enable); |
6c4148ce | 1206 | int ufshcd_wb_toggle_buf_flush(struct ufs_hba *hba, bool enable); |
b294ff3e | 1207 | int ufshcd_suspend_prepare(struct device *dev); |
ddba1cf7 | 1208 | int __ufshcd_suspend_prepare(struct device *dev, bool rpm_ok_for_spm); |
b294ff3e | 1209 | void ufshcd_resume_complete(struct device *dev); |
8e834ca5 | 1210 | |
0263bcd0 | 1211 | /* Wrapper functions for safely calling variant operations */ |
0263bcd0 YG |
1212 | static inline int ufshcd_vops_init(struct ufs_hba *hba) |
1213 | { | |
1214 | if (hba->vops && hba->vops->init) | |
1215 | return hba->vops->init(hba); | |
1216 | ||
1217 | return 0; | |
1218 | } | |
1219 | ||
92bcebe4 SC |
1220 | static inline int ufshcd_vops_phy_initialization(struct ufs_hba *hba) |
1221 | { | |
1222 | if (hba->vops && hba->vops->phy_initialization) | |
1223 | return hba->vops->phy_initialization(hba); | |
1224 | ||
1225 | return 0; | |
1226 | } | |
1227 | ||
35d11ec2 | 1228 | extern const struct ufs_pm_lvl_states ufs_pm_lvl_states[]; |
cbb6813e | 1229 | |
ba80917d TW |
1230 | int ufshcd_dump_regs(struct ufs_hba *hba, size_t offset, size_t len, |
1231 | const char *prefix); | |
1232 | ||
7deedfda AH |
1233 | int __ufshcd_write_ee_control(struct ufs_hba *hba, u32 ee_ctrl_mask); |
1234 | int ufshcd_write_ee_control(struct ufs_hba *hba); | |
35d11ec2 KK |
1235 | int ufshcd_update_ee_control(struct ufs_hba *hba, u16 *mask, |
1236 | const u16 *other_mask, u16 set, u16 clr); | |
cd469475 | 1237 | |
e0eca63e | 1238 | #endif /* End of Header */ |