2 * Universal Flash Storage Host controller driver
4 * This code is based on drivers/scsi/ufs/ufshcd.h
5 * Copyright (C) 2011-2013 Samsung India Software Operations
8 * Santosh Yaraganavi <santosh.sy@samsung.com>
9 * Vinayak Holikatti <h.vinayak@samsung.com>
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version 2
14 * of the License, or (at your option) any later version.
15 * See the COPYING file in the top-level directory or visit
16 * <http://www.gnu.org/licenses/gpl-2.0.html>
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * This program is provided "AS IS" and "WITH ALL FAULTS" and
24 * without warranty of any kind. You are solely responsible for
25 * determining the appropriateness of using and distributing
26 * the program and assume all risks associated with your exercise
27 * of rights with respect to the program, including but not limited
28 * to infringement of third party rights, the risks and costs of
29 * program errors, damage to or loss of data, programs or equipment,
30 * and unavailability or interruption of operations. Under no
31 * circumstances will the contributor of this Program be liable for
32 * any damages of any kind arising from your use or distribution of
39 #include <linux/module.h>
40 #include <linux/kernel.h>
41 #include <linux/init.h>
42 #include <linux/interrupt.h>
44 #include <linux/delay.h>
45 #include <linux/slab.h>
46 #include <linux/spinlock.h>
47 #include <linux/workqueue.h>
48 #include <linux/errno.h>
49 #include <linux/types.h>
50 #include <linux/wait.h>
51 #include <linux/bitops.h>
52 #include <linux/pm_runtime.h>
53 #include <linux/clk.h>
54 #include <linux/completion.h>
55 #include <linux/regulator/consumer.h>
58 #include <asm/byteorder.h>
59 #include <scsi/scsi.h>
60 #include <scsi/scsi_cmnd.h>
61 #include <scsi/scsi_host.h>
62 #include <scsi/scsi_tcq.h>
63 #include <scsi/scsi_dbg.h>
64 #include <scsi/scsi_eh.h>
69 #define UFSHCD "ufshcd"
70 #define UFSHCD_DRIVER_VERSION "0.2"
75 DEV_CMD_TYPE_NOP = 0x0,
76 DEV_CMD_TYPE_QUERY = 0x1,
80 * struct uic_command - UIC command structure
81 * @command: UIC command
82 * @argument1: UIC command argument 1
83 * @argument2: UIC command argument 2
84 * @argument3: UIC command argument 3
85 * @cmd_active: Indicate if UIC command is outstanding
86 * @result: UIC command result
87 * @done: UIC command completion
96 struct completion done;
100 * struct ufshcd_lrb - local reference block
101 * @utr_descriptor_ptr: UTRD address of the command
102 * @ucd_req_ptr: UCD address of the command
103 * @ucd_rsp_ptr: Response UPIU address for this command
104 * @ucd_prdt_ptr: PRDT address of the command
105 * @cmd: pointer to SCSI command
106 * @sense_buffer: pointer to sense buffer address of the SCSI command
107 * @sense_bufflen: Length of the sense buffer
108 * @scsi_status: SCSI status of the command
109 * @command_type: SCSI, UFS, Query.
110 * @task_tag: Task tag of the command
111 * @lun: LUN of the command
112 * @intr_cmd: Interrupt command (doesn't participate in interrupt aggregation)
115 struct utp_transfer_req_desc *utr_descriptor_ptr;
116 struct utp_upiu_req *ucd_req_ptr;
117 struct utp_upiu_rsp *ucd_rsp_ptr;
118 struct ufshcd_sg_entry *ucd_prdt_ptr;
120 struct scsi_cmnd *cmd;
122 unsigned int sense_bufflen;
132 * struct ufs_query - holds relevent data structures for query request
133 * @request: request upiu and function
134 * @descriptor: buffer for sending/receiving descriptor
135 * @response: response upiu and response
138 struct ufs_query_req request;
140 struct ufs_query_res response;
144 * struct ufs_dev_cmd - all assosiated fields with device management commands
145 * @type: device management command type - Query, NOP OUT
146 * @lock: lock to allow one command at a time
147 * @complete: internal commands completion
148 * @tag_wq: wait queue until free command slot is available
151 enum dev_cmd_type type;
153 struct completion *complete;
154 wait_queue_head_t tag_wq;
155 struct ufs_query query;
159 * struct ufs_clk_info - UFS clock related info
160 * @list: list headed by hba->clk_list_head
163 * @max_freq: maximum frequency supported by the clock
164 * @enabled: variable to check against multiple enable/disable
166 struct ufs_clk_info {
167 struct list_head list;
175 #define POST_CHANGE 1
177 * struct ufs_hba_variant_ops - variant specific callbacks
178 * @name: variant name
179 * @init: called when the driver is initialized
180 * @exit: called to cleanup everything done in init
181 * @setup_clocks: called before touching any of the controller registers
182 * @setup_regulators: called before accessing the host controller
183 * @hce_enable_notify: called before and after HCE enable bit is set to allow
184 * variant specific Uni-Pro initialization.
185 * @link_startup_notify: called before and after Link startup is carried out
186 * to allow variant specific Uni-Pro initialization.
188 struct ufs_hba_variant_ops {
190 int (*init)(struct ufs_hba *);
191 void (*exit)(struct ufs_hba *);
192 int (*setup_clocks)(struct ufs_hba *, bool);
193 int (*setup_regulators)(struct ufs_hba *, bool);
194 int (*hce_enable_notify)(struct ufs_hba *, bool);
195 int (*link_startup_notify)(struct ufs_hba *, bool);
199 * struct ufs_hba - per adapter private structure
200 * @mmio_base: UFSHCI base register address
201 * @ucdl_base_addr: UFS Command Descriptor base address
202 * @utrdl_base_addr: UTP Transfer Request Descriptor base address
203 * @utmrdl_base_addr: UTP Task Management Descriptor base address
204 * @ucdl_dma_addr: UFS Command Descriptor DMA address
205 * @utrdl_dma_addr: UTRDL DMA address
206 * @utmrdl_dma_addr: UTMRDL DMA address
207 * @host: Scsi_Host instance of the driver
208 * @dev: device handle
209 * @lrb: local reference block
210 * @lrb_in_use: lrb in use
211 * @outstanding_tasks: Bits representing outstanding task requests
212 * @outstanding_reqs: Bits representing outstanding transfer requests
213 * @capabilities: UFS Controller Capabilities
214 * @nutrs: Transfer Request Queue depth supported by controller
215 * @nutmrs: Task Management Queue depth supported by controller
216 * @ufs_version: UFS Version to which controller complies
217 * @vops: pointer to variant specific operations
218 * @priv: pointer to variant specific private data
219 * @irq: Irq number of the controller
220 * @active_uic_cmd: handle of active UIC command
221 * @uic_cmd_mutex: mutex for uic command
222 * @tm_wq: wait queue for task management
223 * @tm_tag_wq: wait queue for free task management slots
224 * @tm_slots_in_use: bit map of task management request slots in use
225 * @pwr_done: completion for power mode change
226 * @tm_condition: condition variable for task management
227 * @ufshcd_state: UFSHCD states
228 * @eh_flags: Error handling flags
229 * @intr_mask: Interrupt Mask Bits
230 * @ee_ctrl_mask: Exception event control mask
231 * @is_powered: flag to check if HBA is powered
232 * @eh_work: Worker to handle UFS errors that require s/w attention
233 * @eeh_work: Worker to handle exception events
234 * @errors: HBA errors
235 * @uic_error: UFS interconnect layer error status
236 * @saved_err: sticky error mask
237 * @saved_uic_err: sticky UIC error mask
238 * @dev_cmd: ufs device management command information
239 * @auto_bkops_enabled: to track whether bkops is enabled in device
240 * @vreg_info: UFS device voltage regulator information
241 * @clk_list_head: UFS host controller clocks list node head
244 void __iomem *mmio_base;
246 /* Virtual memory reference */
247 struct utp_transfer_cmd_desc *ucdl_base_addr;
248 struct utp_transfer_req_desc *utrdl_base_addr;
249 struct utp_task_req_desc *utmrdl_base_addr;
251 /* DMA memory reference */
252 dma_addr_t ucdl_dma_addr;
253 dma_addr_t utrdl_dma_addr;
254 dma_addr_t utmrdl_dma_addr;
256 struct Scsi_Host *host;
259 struct ufshcd_lrb *lrb;
260 unsigned long lrb_in_use;
262 unsigned long outstanding_tasks;
263 unsigned long outstanding_reqs;
269 struct ufs_hba_variant_ops *vops;
273 struct uic_command *active_uic_cmd;
274 struct mutex uic_cmd_mutex;
276 wait_queue_head_t tm_wq;
277 wait_queue_head_t tm_tag_wq;
278 unsigned long tm_condition;
279 unsigned long tm_slots_in_use;
281 struct completion *pwr_done;
290 struct work_struct eh_work;
291 struct work_struct eeh_work;
299 /* Device management request data */
300 struct ufs_dev_cmd dev_cmd;
302 bool auto_bkops_enabled;
303 struct ufs_vreg_info vreg_info;
304 struct list_head clk_list_head;
307 #define ufshcd_writel(hba, val, reg) \
308 writel((val), (hba)->mmio_base + (reg))
309 #define ufshcd_readl(hba, reg) \
310 readl((hba)->mmio_base + (reg))
312 int ufshcd_alloc_host(struct device *, struct ufs_hba **);
313 int ufshcd_init(struct ufs_hba * , void __iomem * , unsigned int);
314 void ufshcd_remove(struct ufs_hba *);
317 * ufshcd_hba_stop - Send controller to reset state
318 * @hba: per adapter instance
320 static inline void ufshcd_hba_stop(struct ufs_hba *hba)
322 ufshcd_writel(hba, CONTROLLER_DISABLE, REG_CONTROLLER_ENABLE);
325 static inline void check_upiu_size(void)
327 BUILD_BUG_ON(ALIGNED_UPIU_SIZE <
328 GENERAL_UPIU_REQUEST_SIZE + QUERY_DESC_MAX_SIZE);
331 extern int ufshcd_suspend(struct ufs_hba *hba, pm_message_t state);
332 extern int ufshcd_resume(struct ufs_hba *hba);
333 extern int ufshcd_runtime_suspend(struct ufs_hba *hba);
334 extern int ufshcd_runtime_resume(struct ufs_hba *hba);
335 extern int ufshcd_runtime_idle(struct ufs_hba *hba);
336 extern int ufshcd_dme_set_attr(struct ufs_hba *hba, u32 attr_sel,
337 u8 attr_set, u32 mib_val, u8 peer);
338 extern int ufshcd_dme_get_attr(struct ufs_hba *hba, u32 attr_sel,
339 u32 *mib_val, u8 peer);
341 /* UIC command interfaces for DME primitives */
344 #define ATTR_SET_NOR 0 /* NORMAL */
345 #define ATTR_SET_ST 1 /* STATIC */
347 static inline int ufshcd_dme_set(struct ufs_hba *hba, u32 attr_sel,
350 return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
354 static inline int ufshcd_dme_st_set(struct ufs_hba *hba, u32 attr_sel,
357 return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
361 static inline int ufshcd_dme_peer_set(struct ufs_hba *hba, u32 attr_sel,
364 return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
368 static inline int ufshcd_dme_peer_st_set(struct ufs_hba *hba, u32 attr_sel,
371 return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
375 static inline int ufshcd_dme_get(struct ufs_hba *hba,
376 u32 attr_sel, u32 *mib_val)
378 return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_LOCAL);
381 static inline int ufshcd_dme_peer_get(struct ufs_hba *hba,
382 u32 attr_sel, u32 *mib_val)
384 return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_PEER);
387 #endif /* End of Header */