[mirror_ubuntu-artful-kernel.git] / drivers / scsi / ufs / ufshcd.h

/*
 * Universal Flash Storage Host controller driver
 *
 * This code is based on drivers/scsi/ufs/ufshcd.h
 * Copyright (C) 2011-2013 Samsung India Software Operations
 *
 * Authors:
 *	Santosh Yaraganavi <santosh.sy@samsung.com>
 *	Vinayak Holikatti <h.vinayak@samsung.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * See the COPYING file in the top-level directory or visit
 * <http://www.gnu.org/licenses/gpl-2.0.html>
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * This program is provided "AS IS" and "WITH ALL FAULTS" and
 * without warranty of any kind. You are solely responsible for
 * determining the appropriateness of using and distributing
 * the program and assume all risks associated with your exercise
 * of rights with respect to the program, including but not limited
 * to infringement of third party rights, the risks and costs of
 * program errors, damage to or loss of data, programs or equipment,
 * and unavailability or interruption of operations. Under no
 * circumstances will the contributor of this Program be liable for
 * any damages of any kind arising from your use or distribution of
 * this program.
 */

#ifndef _UFSHCD_H
#define _UFSHCD_H

#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/io.h>
#include <linux/delay.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/workqueue.h>
#include <linux/errno.h>
#include <linux/types.h>
#include <linux/wait.h>
#include <linux/bitops.h>
#include <linux/pm_runtime.h>
#include <linux/clk.h>
#include <linux/completion.h>
#include <linux/regulator/consumer.h>

#include <asm/irq.h>
#include <asm/byteorder.h>
#include <scsi/scsi.h>
#include <scsi/scsi_cmnd.h>
#include <scsi/scsi_host.h>
#include <scsi/scsi_tcq.h>
#include <scsi/scsi_dbg.h>
#include <scsi/scsi_eh.h>

#include "ufs.h"
#include "ufshci.h"

#define UFSHCD "ufshcd"
#define UFSHCD_DRIVER_VERSION "0.2"

struct ufs_hba;

enum dev_cmd_type {
	DEV_CMD_TYPE_NOP		= 0x0,
	DEV_CMD_TYPE_QUERY		= 0x1,
};

/**
 * struct uic_command - UIC command structure
 * @command: UIC command
 * @argument1: UIC command argument 1
 * @argument2: UIC command argument 2
 * @argument3: UIC command argument 3
 * @cmd_active: Indicate if UIC command is outstanding
 * @result: UIC command result
 * @done: UIC command completion
 */
struct uic_command {
	u32 command;
	u32 argument1;
	u32 argument2;
	u32 argument3;
	int cmd_active;
	int result;
	struct completion done;
};

/* Used to differentiate the power management options */
enum ufs_pm_op {
	UFS_RUNTIME_PM,
	UFS_SYSTEM_PM,
	UFS_SHUTDOWN_PM,
};

#define ufshcd_is_runtime_pm(op) ((op) == UFS_RUNTIME_PM)
#define ufshcd_is_system_pm(op) ((op) == UFS_SYSTEM_PM)
#define ufshcd_is_shutdown_pm(op) ((op) == UFS_SHUTDOWN_PM)

/* Host <-> Device UniPro Link state */
enum uic_link_state {
	UIC_LINK_OFF_STATE	= 0, /* Link powered down or disabled */
	UIC_LINK_ACTIVE_STATE	= 1, /* Link is in Fast/Slow/Sleep state */
	UIC_LINK_HIBERN8_STATE	= 2, /* Link is in Hibernate state */
};

#define ufshcd_is_link_off(hba) ((hba)->uic_link_state == UIC_LINK_OFF_STATE)
#define ufshcd_is_link_active(hba) ((hba)->uic_link_state == \
				    UIC_LINK_ACTIVE_STATE)
#define ufshcd_is_link_hibern8(hba) ((hba)->uic_link_state == \
				    UIC_LINK_HIBERN8_STATE)
#define ufshcd_set_link_off(hba) ((hba)->uic_link_state = UIC_LINK_OFF_STATE)
#define ufshcd_set_link_active(hba) ((hba)->uic_link_state = \
				    UIC_LINK_ACTIVE_STATE)
#define ufshcd_set_link_hibern8(hba) ((hba)->uic_link_state = \
				    UIC_LINK_HIBERN8_STATE)

/*
 * UFS Power management levels.
 * Each level is in increasing order of power savings.
 */
enum ufs_pm_level {
	UFS_PM_LVL_0, /* UFS_ACTIVE_PWR_MODE, UIC_LINK_ACTIVE_STATE */
	UFS_PM_LVL_1, /* UFS_ACTIVE_PWR_MODE, UIC_LINK_HIBERN8_STATE */
	UFS_PM_LVL_2, /* UFS_SLEEP_PWR_MODE, UIC_LINK_ACTIVE_STATE */
	UFS_PM_LVL_3, /* UFS_SLEEP_PWR_MODE, UIC_LINK_HIBERN8_STATE */
	UFS_PM_LVL_4, /* UFS_POWERDOWN_PWR_MODE, UIC_LINK_HIBERN8_STATE */
	UFS_PM_LVL_5, /* UFS_POWERDOWN_PWR_MODE, UIC_LINK_OFF_STATE */
	UFS_PM_LVL_MAX
};

struct ufs_pm_lvl_states {
	enum ufs_dev_pwr_mode dev_state;
	enum uic_link_state link_state;
};

/**
 * struct ufshcd_lrb - local reference block
 * @utr_descriptor_ptr: UTRD address of the command
 * @ucd_req_ptr: UCD address of the command
 * @ucd_rsp_ptr: Response UPIU address for this command
 * @ucd_prdt_ptr: PRDT address of the command
 * @cmd: pointer to SCSI command
 * @sense_buffer: pointer to sense buffer address of the SCSI command
 * @sense_bufflen: Length of the sense buffer
 * @scsi_status: SCSI status of the command
 * @command_type: SCSI, UFS, Query.
 * @task_tag: Task tag of the command
 * @lun: LUN of the command
 * @intr_cmd: Interrupt command (doesn't participate in interrupt aggregation)
 */
struct ufshcd_lrb {
	struct utp_transfer_req_desc *utr_descriptor_ptr;
	struct utp_upiu_req *ucd_req_ptr;
	struct utp_upiu_rsp *ucd_rsp_ptr;
	struct ufshcd_sg_entry *ucd_prdt_ptr;

	struct scsi_cmnd *cmd;
	u8 *sense_buffer;
	unsigned int sense_bufflen;
	int scsi_status;

	int command_type;
	int task_tag;
	u8 lun; /* UPIU LUN id field is only 8-bit wide */
	bool intr_cmd;
};

/**
 * struct ufs_query - holds relevent data structures for query request
 * @request: request upiu and function
 * @descriptor: buffer for sending/receiving descriptor
 * @response: response upiu and response
 */
struct ufs_query {
	struct ufs_query_req request;
	u8 *descriptor;
	struct ufs_query_res response;
};

/**
 * struct ufs_dev_cmd - all assosiated fields with device management commands
 * @type: device management command type - Query, NOP OUT
 * @lock: lock to allow one command at a time
 * @complete: internal commands completion
 * @tag_wq: wait queue until free command slot is available
 */
struct ufs_dev_cmd {
	enum dev_cmd_type type;
	struct mutex lock;
	struct completion *complete;
	wait_queue_head_t tag_wq;
	struct ufs_query query;
};

/**
 * struct ufs_clk_info - UFS clock related info
 * @list: list headed by hba->clk_list_head
 * @clk: clock node
 * @name: clock name
 * @max_freq: maximum frequency supported by the clock
 * @enabled: variable to check against multiple enable/disable
 */
struct ufs_clk_info {
	struct list_head list;
	struct clk *clk;
	const char *name;
	u32 max_freq;
	bool enabled;
};

#define PRE_CHANGE      0
#define POST_CHANGE     1

struct ufs_pa_layer_attr {
	u32 gear_rx;
	u32 gear_tx;
	u32 lane_rx;
	u32 lane_tx;
	u32 pwr_rx;
	u32 pwr_tx;
	u32 hs_rate;
};

struct ufs_pwr_mode_info {
	bool is_valid;
	struct ufs_pa_layer_attr info;
};

/**
 * struct ufs_hba_variant_ops - variant specific callbacks
 * @name: variant name
 * @init: called when the driver is initialized
 * @exit: called to cleanup everything done in init
 * @setup_clocks: called before touching any of the controller registers
 * @setup_regulators: called before accessing the host controller
 * @hce_enable_notify: called before and after HCE enable bit is set to allow
 *                     variant specific Uni-Pro initialization.
 * @link_startup_notify: called before and after Link startup is carried out
 *                       to allow variant specific Uni-Pro initialization.
 * @pwr_change_notify: called before and after a power mode change
 *			is carried out to allow vendor spesific capabilities
 *			to be set.
 * @suspend: called during host controller PM callback
 * @resume: called during host controller PM callback
 */
struct ufs_hba_variant_ops {
	const char *name;
	int	(*init)(struct ufs_hba *);
	void    (*exit)(struct ufs_hba *);
	int     (*setup_clocks)(struct ufs_hba *, bool);
	int     (*setup_regulators)(struct ufs_hba *, bool);
	int     (*hce_enable_notify)(struct ufs_hba *, bool);
	int     (*link_startup_notify)(struct ufs_hba *, bool);
	int	(*pwr_change_notify)(struct ufs_hba *,
					bool, struct ufs_pa_layer_attr *,
					struct ufs_pa_layer_attr *);
	int     (*suspend)(struct ufs_hba *, enum ufs_pm_op);
	int     (*resume)(struct ufs_hba *, enum ufs_pm_op);
};

/**
 * struct ufs_init_prefetch - contains data that is pre-fetched once during
 * initialization
 * @icc_level: icc level which was read during initialization
 */
struct ufs_init_prefetch {
	u32 icc_level;
};

/**
 * struct ufs_hba - per adapter private structure
 * @mmio_base: UFSHCI base register address
 * @ucdl_base_addr: UFS Command Descriptor base address
 * @utrdl_base_addr: UTP Transfer Request Descriptor base address
 * @utmrdl_base_addr: UTP Task Management Descriptor base address
 * @ucdl_dma_addr: UFS Command Descriptor DMA address
 * @utrdl_dma_addr: UTRDL DMA address
 * @utmrdl_dma_addr: UTMRDL DMA address
 * @host: Scsi_Host instance of the driver
 * @dev: device handle
 * @lrb: local reference block
 * @lrb_in_use: lrb in use
 * @outstanding_tasks: Bits representing outstanding task requests
 * @outstanding_reqs: Bits representing outstanding transfer requests
 * @capabilities: UFS Controller Capabilities
 * @nutrs: Transfer Request Queue depth supported by controller
 * @nutmrs: Task Management Queue depth supported by controller
 * @ufs_version: UFS Version to which controller complies
 * @vops: pointer to variant specific operations
 * @priv: pointer to variant specific private data
 * @irq: Irq number of the controller
 * @active_uic_cmd: handle of active UIC command
 * @uic_cmd_mutex: mutex for uic command
 * @tm_wq: wait queue for task management
 * @tm_tag_wq: wait queue for free task management slots
 * @tm_slots_in_use: bit map of task management request slots in use
 * @pwr_done: completion for power mode change
 * @tm_condition: condition variable for task management
 * @ufshcd_state: UFSHCD states
 * @eh_flags: Error handling flags
 * @intr_mask: Interrupt Mask Bits
 * @ee_ctrl_mask: Exception event control mask
 * @is_powered: flag to check if HBA is powered
 * @is_init_prefetch: flag to check if data was pre-fetched in initialization
 * @init_prefetch_data: data pre-fetched during initialization
 * @eh_work: Worker to handle UFS errors that require s/w attention
 * @eeh_work: Worker to handle exception events
 * @errors: HBA errors
 * @uic_error: UFS interconnect layer error status
 * @saved_err: sticky error mask
 * @saved_uic_err: sticky UIC error mask
 * @dev_cmd: ufs device management command information
 * @auto_bkops_enabled: to track whether bkops is enabled in device
 * @vreg_info: UFS device voltage regulator information
 * @clk_list_head: UFS host controller clocks list node head
 * @pwr_info: holds current power mode
 * @max_pwr_info: keeps the device max valid pwm
 */
struct ufs_hba {
	void __iomem *mmio_base;

	/* Virtual memory reference */
	struct utp_transfer_cmd_desc *ucdl_base_addr;
	struct utp_transfer_req_desc *utrdl_base_addr;
	struct utp_task_req_desc *utmrdl_base_addr;

	/* DMA memory reference */
	dma_addr_t ucdl_dma_addr;
	dma_addr_t utrdl_dma_addr;
	dma_addr_t utmrdl_dma_addr;

	struct Scsi_Host *host;
	struct device *dev;
	/*
	 * This field is to keep a reference to "scsi_device" corresponding to
	 * "UFS device" W-LU.
	 */
	struct scsi_device *sdev_ufs_device;
	struct scsi_device *sdev_rpmb;
	struct scsi_device *sdev_boot;

	enum ufs_dev_pwr_mode curr_dev_pwr_mode;
	enum uic_link_state uic_link_state;
	/* Desired UFS power management level during runtime PM */
	enum ufs_pm_level rpm_lvl;
	/* Desired UFS power management level during system PM */
	enum ufs_pm_level spm_lvl;
	int pm_op_in_progress;

	struct ufshcd_lrb *lrb;
	unsigned long lrb_in_use;

	unsigned long outstanding_tasks;
	unsigned long outstanding_reqs;

	u32 capabilities;
	int nutrs;
	int nutmrs;
	u32 ufs_version;
	struct ufs_hba_variant_ops *vops;
	void *priv;
	unsigned int irq;
	bool is_irq_enabled;


	wait_queue_head_t tm_wq;
	wait_queue_head_t tm_tag_wq;
	unsigned long tm_condition;
	unsigned long tm_slots_in_use;

	struct uic_command *active_uic_cmd;
	struct mutex uic_cmd_mutex;
	struct completion *uic_async_done;

	u32 ufshcd_state;
	u32 eh_flags;
	u32 intr_mask;
	u16 ee_ctrl_mask;
	bool is_powered;
	bool is_init_prefetch;
	struct ufs_init_prefetch init_prefetch_data;

	/* Work Queues */
	struct work_struct eh_work;
	struct work_struct eeh_work;

	/* HBA Errors */
	u32 errors;
	u32 uic_error;
	u32 saved_err;
	u32 saved_uic_err;

	/* Device management request data */
	struct ufs_dev_cmd dev_cmd;

	/* Keeps information of the UFS device connected to this host */
	struct ufs_dev_info dev_info;
	bool auto_bkops_enabled;
	struct ufs_vreg_info vreg_info;
	struct list_head clk_list_head;

	bool wlun_dev_clr_ua;

	struct ufs_pa_layer_attr pwr_info;
	struct ufs_pwr_mode_info max_pwr_info;
};

#define ufshcd_writel(hba, val, reg)	\
	writel((val), (hba)->mmio_base + (reg))
#define ufshcd_readl(hba, reg)	\
	readl((hba)->mmio_base + (reg))

int ufshcd_alloc_host(struct device *, struct ufs_hba **);
int ufshcd_init(struct ufs_hba * , void __iomem * , unsigned int);
void ufshcd_remove(struct ufs_hba *);

/**
 * ufshcd_hba_stop - Send controller to reset state
 * @hba: per adapter instance
 */
static inline void ufshcd_hba_stop(struct ufs_hba *hba)
{
	ufshcd_writel(hba, CONTROLLER_DISABLE,  REG_CONTROLLER_ENABLE);
}

static inline void check_upiu_size(void)
{
	BUILD_BUG_ON(ALIGNED_UPIU_SIZE <
		GENERAL_UPIU_REQUEST_SIZE + QUERY_DESC_MAX_SIZE);
}

extern int ufshcd_runtime_suspend(struct ufs_hba *hba);
extern int ufshcd_runtime_resume(struct ufs_hba *hba);
extern int ufshcd_runtime_idle(struct ufs_hba *hba);
extern int ufshcd_system_suspend(struct ufs_hba *hba);
extern int ufshcd_system_resume(struct ufs_hba *hba);
extern int ufshcd_shutdown(struct ufs_hba *hba);
extern int ufshcd_dme_set_attr(struct ufs_hba *hba, u32 attr_sel,
			       u8 attr_set, u32 mib_val, u8 peer);
extern int ufshcd_dme_get_attr(struct ufs_hba *hba, u32 attr_sel,
			       u32 *mib_val, u8 peer);

/* UIC command interfaces for DME primitives */
#define DME_LOCAL	0
#define DME_PEER	1
#define ATTR_SET_NOR	0	/* NORMAL */
#define ATTR_SET_ST	1	/* STATIC */

static inline int ufshcd_dme_set(struct ufs_hba *hba, u32 attr_sel,
				 u32 mib_val)
{
	return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
				   mib_val, DME_LOCAL);
}

static inline int ufshcd_dme_st_set(struct ufs_hba *hba, u32 attr_sel,
				    u32 mib_val)
{
	return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
				   mib_val, DME_LOCAL);
}

static inline int ufshcd_dme_peer_set(struct ufs_hba *hba, u32 attr_sel,
				      u32 mib_val)
{
	return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
				   mib_val, DME_PEER);
}

static inline int ufshcd_dme_peer_st_set(struct ufs_hba *hba, u32 attr_sel,
					 u32 mib_val)
{
	return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
				   mib_val, DME_PEER);
}

static inline int ufshcd_dme_get(struct ufs_hba *hba,
				 u32 attr_sel, u32 *mib_val)
{
	return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_LOCAL);
}

static inline int ufshcd_dme_peer_get(struct ufs_hba *hba,
				      u32 attr_sel, u32 *mib_val)
{
	return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_PEER);
}

#endif /* End of Header */
Commit	Line	Data
e0eca63e VH	1	/*
	2	* Universal Flash Storage Host controller driver
	3	*
	4	* This code is based on drivers/scsi/ufs/ufshcd.h
	5	* Copyright (C) 2011-2013 Samsung India Software Operations
	6	*
	7	* Authors:
	8	* Santosh Yaraganavi <santosh.sy@samsung.com>
	9	* Vinayak Holikatti <h.vinayak@samsung.com>
	10	*
	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>
	17	*
	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.
	22	*
	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
	33	* this program.
	34	*/
	35
	36	#ifndef _UFSHCD_H
	37	#define _UFSHCD_H
	38
	39	#include <linux/module.h>
	40	#include <linux/kernel.h>
	41	#include <linux/init.h>
	42	#include <linux/interrupt.h>
	43	#include <linux/io.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>
6ccf44fe	54	#include <linux/completion.h>
aa497613	55	#include <linux/regulator/consumer.h>
e0eca63e VH	56
	57	#include <asm/irq.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>
	65
	66	#include "ufs.h"
	67	#include "ufshci.h"
	68
	69	#define UFSHCD "ufshcd"
	70	#define UFSHCD_DRIVER_VERSION "0.2"
	71
5c0c28a8 SRT	72	struct ufs_hba;
5c0c28a8 SRT	73
5a0b0cb9 SRT	74	enum dev_cmd_type {
5a0b0cb9 SRT	75	DEV_CMD_TYPE_NOP = 0x0,
68078d5c	76	DEV_CMD_TYPE_QUERY = 0x1,
5a0b0cb9 SRT	77	};
5a0b0cb9 SRT	78
e0eca63e VH	79	/**
	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
6ccf44fe	87	* @done: UIC command completion
e0eca63e VH	88	*/
	89	struct uic_command {
	90	u32 command;
	91	u32 argument1;
	92	u32 argument2;
	93	u32 argument3;
	94	int cmd_active;
	95	int result;
6ccf44fe	96	struct completion done;
e0eca63e VH	97	};
e0eca63e VH	98
57d104c1 SJ	99	/* Used to differentiate the power management options */
	100	enum ufs_pm_op {
	101	UFS_RUNTIME_PM,
	102	UFS_SYSTEM_PM,
	103	UFS_SHUTDOWN_PM,
	104	};
	105
	106	#define ufshcd_is_runtime_pm(op) ((op) == UFS_RUNTIME_PM)
	107	#define ufshcd_is_system_pm(op) ((op) == UFS_SYSTEM_PM)
	108	#define ufshcd_is_shutdown_pm(op) ((op) == UFS_SHUTDOWN_PM)
	109
	110	/* Host <-> Device UniPro Link state */
	111	enum uic_link_state {
	112	UIC_LINK_OFF_STATE = 0, /* Link powered down or disabled */
	113	UIC_LINK_ACTIVE_STATE = 1, /* Link is in Fast/Slow/Sleep state */
	114	UIC_LINK_HIBERN8_STATE = 2, /* Link is in Hibernate state */
	115	};
	116
	117	#define ufshcd_is_link_off(hba) ((hba)->uic_link_state == UIC_LINK_OFF_STATE)
	118	#define ufshcd_is_link_active(hba) ((hba)->uic_link_state == \
	119	UIC_LINK_ACTIVE_STATE)
	120	#define ufshcd_is_link_hibern8(hba) ((hba)->uic_link_state == \
	121	UIC_LINK_HIBERN8_STATE)
	122	#define ufshcd_set_link_off(hba) ((hba)->uic_link_state = UIC_LINK_OFF_STATE)
	123	#define ufshcd_set_link_active(hba) ((hba)->uic_link_state = \
	124	UIC_LINK_ACTIVE_STATE)
	125	#define ufshcd_set_link_hibern8(hba) ((hba)->uic_link_state = \
	126	UIC_LINK_HIBERN8_STATE)
	127
	128	/*
	129	* UFS Power management levels.
	130	* Each level is in increasing order of power savings.
	131	*/
	132	enum ufs_pm_level {
	133	UFS_PM_LVL_0, /* UFS_ACTIVE_PWR_MODE, UIC_LINK_ACTIVE_STATE */
	134	UFS_PM_LVL_1, /* UFS_ACTIVE_PWR_MODE, UIC_LINK_HIBERN8_STATE */
	135	UFS_PM_LVL_2, /* UFS_SLEEP_PWR_MODE, UIC_LINK_ACTIVE_STATE */
	136	UFS_PM_LVL_3, /* UFS_SLEEP_PWR_MODE, UIC_LINK_HIBERN8_STATE */
	137	UFS_PM_LVL_4, /* UFS_POWERDOWN_PWR_MODE, UIC_LINK_HIBERN8_STATE */
	138	UFS_PM_LVL_5, /* UFS_POWERDOWN_PWR_MODE, UIC_LINK_OFF_STATE */
	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
	153	* @cmd: pointer to SCSI command
	154	* @sense_buffer: pointer to sense buffer address of the SCSI command
	155	* @sense_bufflen: Length of the sense buffer
	156	* @scsi_status: SCSI status of the command
	157	* @command_type: SCSI, UFS, Query.
	158	* @task_tag: Task tag of the command
	159	* @lun: LUN of the command
5a0b0cb9	160	* @intr_cmd: Interrupt command (doesn't participate in interrupt aggregation)
e0eca63e VH	161	*/
	162	struct ufshcd_lrb {
	163	struct utp_transfer_req_desc *utr_descriptor_ptr;
5a0b0cb9	164	struct utp_upiu_req *ucd_req_ptr;
e0eca63e VH	165	struct utp_upiu_rsp *ucd_rsp_ptr;
	166	struct ufshcd_sg_entry *ucd_prdt_ptr;
	167
	168	struct scsi_cmnd *cmd;
	169	u8 *sense_buffer;
	170	unsigned int sense_bufflen;
	171	int scsi_status;
	172
	173	int command_type;
	174	int task_tag;
0ce147d4	175	u8 lun; /* UPIU LUN id field is only 8-bit wide */
5a0b0cb9	176	bool intr_cmd;
e0eca63e VH	177	};
e0eca63e VH	178
68078d5c DR	179	/**
	180	* struct ufs_query - holds relevent data structures for query request
	181	* @request: request upiu and function
	182	* @descriptor: buffer for sending/receiving descriptor
	183	* @response: response upiu and response
	184	*/
	185	struct ufs_query {
	186	struct ufs_query_req request;
	187	u8 *descriptor;
	188	struct ufs_query_res response;
	189	};
	190
5a0b0cb9 SRT	191	/**
	192	* struct ufs_dev_cmd - all assosiated fields with device management commands
	193	* @type: device management command type - Query, NOP OUT
	194	* @lock: lock to allow one command at a time
	195	* @complete: internal commands completion
	196	* @tag_wq: wait queue until free command slot is available
	197	*/
	198	struct ufs_dev_cmd {
	199	enum dev_cmd_type type;
	200	struct mutex lock;
	201	struct completion *complete;
	202	wait_queue_head_t tag_wq;
68078d5c	203	struct ufs_query query;
5a0b0cb9	204	};
e0eca63e	205
c6e79dac SRT	206	/**
	207	* struct ufs_clk_info - UFS clock related info
	208	* @list: list headed by hba->clk_list_head
	209	* @clk: clock node
	210	* @name: clock name
	211	* @max_freq: maximum frequency supported by the clock
	212	* @enabled: variable to check against multiple enable/disable
	213	*/
	214	struct ufs_clk_info {
	215	struct list_head list;
	216	struct clk *clk;
	217	const char *name;
	218	u32 max_freq;
	219	bool enabled;
	220	};
	221
5c0c28a8 SRT	222	#define PRE_CHANGE 0
5c0c28a8 SRT	223	#define POST_CHANGE 1
7eb584db DR	224
	225	struct ufs_pa_layer_attr {
	226	u32 gear_rx;
	227	u32 gear_tx;
	228	u32 lane_rx;
	229	u32 lane_tx;
	230	u32 pwr_rx;
	231	u32 pwr_tx;
	232	u32 hs_rate;
	233	};
	234
	235	struct ufs_pwr_mode_info {
	236	bool is_valid;
	237	struct ufs_pa_layer_attr info;
	238	};
	239
5c0c28a8 SRT	240	/**
	241	* struct ufs_hba_variant_ops - variant specific callbacks
	242	* @name: variant name
	243	* @init: called when the driver is initialized
	244	* @exit: called to cleanup everything done in init
	245	* @setup_clocks: called before touching any of the controller registers
	246	* @setup_regulators: called before accessing the host controller
	247	* @hce_enable_notify: called before and after HCE enable bit is set to allow
	248	* variant specific Uni-Pro initialization.
	249	* @link_startup_notify: called before and after Link startup is carried out
	250	* to allow variant specific Uni-Pro initialization.
7eb584db DR	251	* @pwr_change_notify: called before and after a power mode change
	252	* is carried out to allow vendor spesific capabilities
	253	* to be set.
57d104c1 SJ	254	* @suspend: called during host controller PM callback
57d104c1 SJ	255	* @resume: called during host controller PM callback
5c0c28a8 SRT	256	*/
	257	struct ufs_hba_variant_ops {
	258	const char *name;
	259	int (init)(struct ufs_hba );
	260	void (exit)(struct ufs_hba );
	261	int (setup_clocks)(struct ufs_hba , bool);
	262	int (setup_regulators)(struct ufs_hba , bool);
	263	int (hce_enable_notify)(struct ufs_hba , bool);
	264	int (link_startup_notify)(struct ufs_hba , bool);
7eb584db DR	265	int (pwr_change_notify)(struct ufs_hba ,
	266	bool, struct ufs_pa_layer_attr *,
	267	struct ufs_pa_layer_attr *);
57d104c1 SJ	268	int (suspend)(struct ufs_hba , enum ufs_pm_op);
57d104c1 SJ	269	int (resume)(struct ufs_hba , enum ufs_pm_op);
5c0c28a8 SRT	270	};
5c0c28a8 SRT	271
3a4bf06d YG	272	/**
	273	* struct ufs_init_prefetch - contains data that is pre-fetched once during
	274	* initialization
	275	* @icc_level: icc level which was read during initialization
	276	*/
	277	struct ufs_init_prefetch {
	278	u32 icc_level;
	279	};
	280
e0eca63e VH	281	/**
	282	* struct ufs_hba - per adapter private structure
	283	* @mmio_base: UFSHCI base register address
	284	* @ucdl_base_addr: UFS Command Descriptor base address
	285	* @utrdl_base_addr: UTP Transfer Request Descriptor base address
	286	* @utmrdl_base_addr: UTP Task Management Descriptor base address
	287	* @ucdl_dma_addr: UFS Command Descriptor DMA address
	288	* @utrdl_dma_addr: UTRDL DMA address
	289	* @utmrdl_dma_addr: UTMRDL DMA address
	290	* @host: Scsi_Host instance of the driver
	291	* @dev: device handle
	292	* @lrb: local reference block
5a0b0cb9	293	* @lrb_in_use: lrb in use
e0eca63e VH	294	* @outstanding_tasks: Bits representing outstanding task requests
	295	* @outstanding_reqs: Bits representing outstanding transfer requests
	296	* @capabilities: UFS Controller Capabilities
	297	* @nutrs: Transfer Request Queue depth supported by controller
	298	* @nutmrs: Task Management Queue depth supported by controller
	299	* @ufs_version: UFS Version to which controller complies
5c0c28a8 SRT	300	* @vops: pointer to variant specific operations
5c0c28a8 SRT	301	* @priv: pointer to variant specific private data
e0eca63e VH	302	* @irq: Irq number of the controller
e0eca63e VH	303	* @active_uic_cmd: handle of active UIC command
6ccf44fe	304	* @uic_cmd_mutex: mutex for uic command
e2933132 SRT	305	* @tm_wq: wait queue for task management
	306	* @tm_tag_wq: wait queue for free task management slots
	307	* @tm_slots_in_use: bit map of task management request slots in use
53b3d9c3	308	* @pwr_done: completion for power mode change
e0eca63e VH	309	* @tm_condition: condition variable for task management
e0eca63e VH	310	* @ufshcd_state: UFSHCD states
3441da7d	311	* @eh_flags: Error handling flags
2fbd009b	312	* @intr_mask: Interrupt Mask Bits
66ec6d59	313	* @ee_ctrl_mask: Exception event control mask
1d337ec2	314	* @is_powered: flag to check if HBA is powered
3a4bf06d YG	315	* @is_init_prefetch: flag to check if data was pre-fetched in initialization
3a4bf06d YG	316	* @init_prefetch_data: data pre-fetched during initialization
e8e7f271	317	* @eh_work: Worker to handle UFS errors that require s/w attention
66ec6d59	318	* @eeh_work: Worker to handle exception events
e0eca63e	319	* @errors: HBA errors
e8e7f271 SRT	320	* @uic_error: UFS interconnect layer error status
	321	* @saved_err: sticky error mask
	322	* @saved_uic_err: sticky UIC error mask
5a0b0cb9	323	* @dev_cmd: ufs device management command information
66ec6d59	324	* @auto_bkops_enabled: to track whether bkops is enabled in device
aa497613	325	* @vreg_info: UFS device voltage regulator information
c6e79dac	326	* @clk_list_head: UFS host controller clocks list node head
7eb584db DR	327	* @pwr_info: holds current power mode
7eb584db DR	328	* @max_pwr_info: keeps the device max valid pwm
e0eca63e VH	329	*/
	330	struct ufs_hba {
	331	void __iomem *mmio_base;
	332
	333	/* Virtual memory reference */
	334	struct utp_transfer_cmd_desc *ucdl_base_addr;
	335	struct utp_transfer_req_desc *utrdl_base_addr;
	336	struct utp_task_req_desc *utmrdl_base_addr;
	337
	338	/* DMA memory reference */
	339	dma_addr_t ucdl_dma_addr;
	340	dma_addr_t utrdl_dma_addr;
	341	dma_addr_t utmrdl_dma_addr;
	342
	343	struct Scsi_Host *host;
	344	struct device *dev;
2a8fa600 SJ	345	/*
	346	* This field is to keep a reference to "scsi_device" corresponding to
	347	* "UFS device" W-LU.
	348	*/
	349	struct scsi_device *sdev_ufs_device;
	350	struct scsi_device *sdev_rpmb;
	351	struct scsi_device *sdev_boot;
e0eca63e	352
57d104c1 SJ	353	enum ufs_dev_pwr_mode curr_dev_pwr_mode;
	354	enum uic_link_state uic_link_state;
	355	/* Desired UFS power management level during runtime PM */
	356	enum ufs_pm_level rpm_lvl;
	357	/* Desired UFS power management level during system PM */
	358	enum ufs_pm_level spm_lvl;
	359	int pm_op_in_progress;
	360
e0eca63e	361	struct ufshcd_lrb *lrb;
5a0b0cb9	362	unsigned long lrb_in_use;
e0eca63e VH	363
	364	unsigned long outstanding_tasks;
	365	unsigned long outstanding_reqs;
	366
	367	u32 capabilities;
	368	int nutrs;
	369	int nutmrs;
	370	u32 ufs_version;
5c0c28a8 SRT	371	struct ufs_hba_variant_ops *vops;
5c0c28a8 SRT	372	void *priv;
e0eca63e	373	unsigned int irq;
57d104c1	374	bool is_irq_enabled;
e0eca63e	375
6ccf44fe	376
e2933132 SRT	377	wait_queue_head_t tm_wq;
e2933132 SRT	378	wait_queue_head_t tm_tag_wq;
e0eca63e	379	unsigned long tm_condition;
e2933132	380	unsigned long tm_slots_in_use;
e0eca63e	381
57d104c1 SJ	382	struct uic_command *active_uic_cmd;
	383	struct mutex uic_cmd_mutex;
	384	struct completion *uic_async_done;
53b3d9c3	385
e0eca63e	386	u32 ufshcd_state;
3441da7d	387	u32 eh_flags;
2fbd009b	388	u32 intr_mask;
66ec6d59	389	u16 ee_ctrl_mask;
1d337ec2	390	bool is_powered;
3a4bf06d YG	391	bool is_init_prefetch;
3a4bf06d YG	392	struct ufs_init_prefetch init_prefetch_data;
e0eca63e VH	393
e0eca63e VH	394	/* Work Queues */
e8e7f271	395	struct work_struct eh_work;
66ec6d59	396	struct work_struct eeh_work;
e0eca63e VH	397
	398	/* HBA Errors */
	399	u32 errors;
e8e7f271 SRT	400	u32 uic_error;
	401	u32 saved_err;
	402	u32 saved_uic_err;
5a0b0cb9 SRT	403
	404	/* Device management request data */
	405	struct ufs_dev_cmd dev_cmd;
66ec6d59	406
57d104c1 SJ	407	/* Keeps information of the UFS device connected to this host */
57d104c1 SJ	408	struct ufs_dev_info dev_info;
66ec6d59	409	bool auto_bkops_enabled;
aa497613	410	struct ufs_vreg_info vreg_info;
c6e79dac	411	struct list_head clk_list_head;
57d104c1 SJ	412
57d104c1 SJ	413	bool wlun_dev_clr_ua;
7eb584db DR	414
	415	struct ufs_pa_layer_attr pwr_info;
	416	struct ufs_pwr_mode_info max_pwr_info;
e0eca63e VH	417	};
e0eca63e VH	418
b873a275 SJ	419	#define ufshcd_writel(hba, val, reg) \
	420	writel((val), (hba)->mmio_base + (reg))
	421	#define ufshcd_readl(hba, reg) \
	422	readl((hba)->mmio_base + (reg))
	423
5c0c28a8 SRT	424	int ufshcd_alloc_host(struct device , struct ufs_hba *);
5c0c28a8 SRT	425	int ufshcd_init(struct ufs_hba * , void __iomem * , unsigned int);
e0eca63e VH	426	void ufshcd_remove(struct ufs_hba *);
	427
	428	/**
	429	* ufshcd_hba_stop - Send controller to reset state
	430	* @hba: per adapter instance
	431	*/
	432	static inline void ufshcd_hba_stop(struct ufs_hba *hba)
	433	{
b873a275	434	ufshcd_writel(hba, CONTROLLER_DISABLE, REG_CONTROLLER_ENABLE);
e0eca63e VH	435	}
e0eca63e VH	436
68078d5c DR	437	static inline void check_upiu_size(void)
	438	{
	439	BUILD_BUG_ON(ALIGNED_UPIU_SIZE <
	440	GENERAL_UPIU_REQUEST_SIZE + QUERY_DESC_MAX_SIZE);
	441	}
	442
66ec6d59 SRT	443	extern int ufshcd_runtime_suspend(struct ufs_hba *hba);
	444	extern int ufshcd_runtime_resume(struct ufs_hba *hba);
	445	extern int ufshcd_runtime_idle(struct ufs_hba *hba);
57d104c1 SJ	446	extern int ufshcd_system_suspend(struct ufs_hba *hba);
	447	extern int ufshcd_system_resume(struct ufs_hba *hba);
	448	extern int ufshcd_shutdown(struct ufs_hba *hba);
12b4fdb4 SJ	449	extern int ufshcd_dme_set_attr(struct ufs_hba *hba, u32 attr_sel,
	450	u8 attr_set, u32 mib_val, u8 peer);
	451	extern int ufshcd_dme_get_attr(struct ufs_hba *hba, u32 attr_sel,
	452	u32 *mib_val, u8 peer);
	453
	454	/* UIC command interfaces for DME primitives */
	455	#define DME_LOCAL 0
	456	#define DME_PEER 1
	457	#define ATTR_SET_NOR 0 /* NORMAL */
	458	#define ATTR_SET_ST 1 /* STATIC */
	459
	460	static inline int ufshcd_dme_set(struct ufs_hba *hba, u32 attr_sel,
	461	u32 mib_val)
	462	{
	463	return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
	464	mib_val, DME_LOCAL);
	465	}
	466
	467	static inline int ufshcd_dme_st_set(struct ufs_hba *hba, u32 attr_sel,
	468	u32 mib_val)
	469	{
	470	return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
	471	mib_val, DME_LOCAL);
	472	}
	473
	474	static inline int ufshcd_dme_peer_set(struct ufs_hba *hba, u32 attr_sel,
	475	u32 mib_val)
	476	{
	477	return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
	478	mib_val, DME_PEER);
	479	}
	480
	481	static inline int ufshcd_dme_peer_st_set(struct ufs_hba *hba, u32 attr_sel,
	482	u32 mib_val)
	483	{
	484	return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
	485	mib_val, DME_PEER);
	486	}
	487
	488	static inline int ufshcd_dme_get(struct ufs_hba *hba,
	489	u32 attr_sel, u32 *mib_val)
	490	{
	491	return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_LOCAL);
	492	}
	493
	494	static inline int ufshcd_dme_peer_get(struct ufs_hba *hba,
	495	u32 attr_sel, u32 *mib_val)
	496	{
	497	return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_PEER);
	498	}
	499
e0eca63e	500	#endif /* End of Header */