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>
57 #include <asm/byteorder.h>
58 #include <scsi/scsi.h>
59 #include <scsi/scsi_cmnd.h>
60 #include <scsi/scsi_host.h>
61 #include <scsi/scsi_tcq.h>
62 #include <scsi/scsi_dbg.h>
63 #include <scsi/scsi_eh.h>
68 #define UFSHCD "ufshcd"
69 #define UFSHCD_DRIVER_VERSION "0.2"
72 DEV_CMD_TYPE_NOP = 0x0,
73 DEV_CMD_TYPE_QUERY = 0x1,
77 * struct uic_command - UIC command structure
78 * @command: UIC command
79 * @argument1: UIC command argument 1
80 * @argument2: UIC command argument 2
81 * @argument3: UIC command argument 3
82 * @cmd_active: Indicate if UIC command is outstanding
83 * @result: UIC command result
84 * @done: UIC command completion
93 struct completion done;
97 * struct ufshcd_lrb - local reference block
98 * @utr_descriptor_ptr: UTRD address of the command
99 * @ucd_req_ptr: UCD address of the command
100 * @ucd_rsp_ptr: Response UPIU address for this command
101 * @ucd_prdt_ptr: PRDT address of the command
102 * @cmd: pointer to SCSI command
103 * @sense_buffer: pointer to sense buffer address of the SCSI command
104 * @sense_bufflen: Length of the sense buffer
105 * @scsi_status: SCSI status of the command
106 * @command_type: SCSI, UFS, Query.
107 * @task_tag: Task tag of the command
108 * @lun: LUN of the command
109 * @intr_cmd: Interrupt command (doesn't participate in interrupt aggregation)
112 struct utp_transfer_req_desc *utr_descriptor_ptr;
113 struct utp_upiu_req *ucd_req_ptr;
114 struct utp_upiu_rsp *ucd_rsp_ptr;
115 struct ufshcd_sg_entry *ucd_prdt_ptr;
117 struct scsi_cmnd *cmd;
119 unsigned int sense_bufflen;
129 * struct ufs_query - holds relevent data structures for query request
130 * @request: request upiu and function
131 * @descriptor: buffer for sending/receiving descriptor
132 * @response: response upiu and response
135 struct ufs_query_req request;
137 struct ufs_query_res response;
141 * struct ufs_dev_cmd - all assosiated fields with device management commands
142 * @type: device management command type - Query, NOP OUT
143 * @lock: lock to allow one command at a time
144 * @complete: internal commands completion
145 * @tag_wq: wait queue until free command slot is available
148 enum dev_cmd_type type;
150 struct completion *complete;
151 wait_queue_head_t tag_wq;
152 struct ufs_query query;
156 * struct ufs_hba - per adapter private structure
157 * @mmio_base: UFSHCI base register address
158 * @ucdl_base_addr: UFS Command Descriptor base address
159 * @utrdl_base_addr: UTP Transfer Request Descriptor base address
160 * @utmrdl_base_addr: UTP Task Management Descriptor base address
161 * @ucdl_dma_addr: UFS Command Descriptor DMA address
162 * @utrdl_dma_addr: UTRDL DMA address
163 * @utmrdl_dma_addr: UTMRDL DMA address
164 * @host: Scsi_Host instance of the driver
165 * @dev: device handle
166 * @lrb: local reference block
167 * @lrb_in_use: lrb in use
168 * @outstanding_tasks: Bits representing outstanding task requests
169 * @outstanding_reqs: Bits representing outstanding transfer requests
170 * @capabilities: UFS Controller Capabilities
171 * @nutrs: Transfer Request Queue depth supported by controller
172 * @nutmrs: Task Management Queue depth supported by controller
173 * @ufs_version: UFS Version to which controller complies
174 * @irq: Irq number of the controller
175 * @active_uic_cmd: handle of active UIC command
176 * @uic_cmd_mutex: mutex for uic command
177 * @tm_wq: wait queue for task management
178 * @tm_tag_wq: wait queue for free task management slots
179 * @tm_slots_in_use: bit map of task management request slots in use
180 * @pwr_done: completion for power mode change
181 * @tm_condition: condition variable for task management
182 * @ufshcd_state: UFSHCD states
183 * @eh_flags: Error handling flags
184 * @intr_mask: Interrupt Mask Bits
185 * @ee_ctrl_mask: Exception event control mask
186 * @eh_work: Worker to handle UFS errors that require s/w attention
187 * @eeh_work: Worker to handle exception events
188 * @errors: HBA errors
189 * @uic_error: UFS interconnect layer error status
190 * @saved_err: sticky error mask
191 * @saved_uic_err: sticky UIC error mask
192 * @dev_cmd: ufs device management command information
193 * @auto_bkops_enabled: to track whether bkops is enabled in device
196 void __iomem *mmio_base;
198 /* Virtual memory reference */
199 struct utp_transfer_cmd_desc *ucdl_base_addr;
200 struct utp_transfer_req_desc *utrdl_base_addr;
201 struct utp_task_req_desc *utmrdl_base_addr;
203 /* DMA memory reference */
204 dma_addr_t ucdl_dma_addr;
205 dma_addr_t utrdl_dma_addr;
206 dma_addr_t utmrdl_dma_addr;
208 struct Scsi_Host *host;
211 struct ufshcd_lrb *lrb;
212 unsigned long lrb_in_use;
214 unsigned long outstanding_tasks;
215 unsigned long outstanding_reqs;
223 struct uic_command *active_uic_cmd;
224 struct mutex uic_cmd_mutex;
226 wait_queue_head_t tm_wq;
227 wait_queue_head_t tm_tag_wq;
228 unsigned long tm_condition;
229 unsigned long tm_slots_in_use;
231 struct completion *pwr_done;
239 struct work_struct eh_work;
240 struct work_struct eeh_work;
248 /* Device management request data */
249 struct ufs_dev_cmd dev_cmd;
251 bool auto_bkops_enabled;
254 #define ufshcd_writel(hba, val, reg) \
255 writel((val), (hba)->mmio_base + (reg))
256 #define ufshcd_readl(hba, reg) \
257 readl((hba)->mmio_base + (reg))
259 int ufshcd_init(struct device *, struct ufs_hba ** , void __iomem * ,
261 void ufshcd_remove(struct ufs_hba *);
264 * ufshcd_hba_stop - Send controller to reset state
265 * @hba: per adapter instance
267 static inline void ufshcd_hba_stop(struct ufs_hba *hba)
269 ufshcd_writel(hba, CONTROLLER_DISABLE, REG_CONTROLLER_ENABLE);
272 static inline void check_upiu_size(void)
274 BUILD_BUG_ON(ALIGNED_UPIU_SIZE <
275 GENERAL_UPIU_REQUEST_SIZE + QUERY_DESC_MAX_SIZE);
278 extern int ufshcd_suspend(struct ufs_hba *hba, pm_message_t state);
279 extern int ufshcd_resume(struct ufs_hba *hba);
280 extern int ufshcd_runtime_suspend(struct ufs_hba *hba);
281 extern int ufshcd_runtime_resume(struct ufs_hba *hba);
282 extern int ufshcd_runtime_idle(struct ufs_hba *hba);
283 extern int ufshcd_dme_set_attr(struct ufs_hba *hba, u32 attr_sel,
284 u8 attr_set, u32 mib_val, u8 peer);
285 extern int ufshcd_dme_get_attr(struct ufs_hba *hba, u32 attr_sel,
286 u32 *mib_val, u8 peer);
288 /* UIC command interfaces for DME primitives */
291 #define ATTR_SET_NOR 0 /* NORMAL */
292 #define ATTR_SET_ST 1 /* STATIC */
294 static inline int ufshcd_dme_set(struct ufs_hba *hba, u32 attr_sel,
297 return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
301 static inline int ufshcd_dme_st_set(struct ufs_hba *hba, u32 attr_sel,
304 return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
308 static inline int ufshcd_dme_peer_set(struct ufs_hba *hba, u32 attr_sel,
311 return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
315 static inline int ufshcd_dme_peer_st_set(struct ufs_hba *hba, u32 attr_sel,
318 return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
322 static inline int ufshcd_dme_get(struct ufs_hba *hba,
323 u32 attr_sel, u32 *mib_val)
325 return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_LOCAL);
328 static inline int ufshcd_dme_peer_get(struct ufs_hba *hba,
329 u32 attr_sel, u32 *mib_val)
331 return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_PEER);
334 #endif /* End of Header */