drivers/scsi/oufs/ufshpb.h - LeafOS-Devices/android_kernel_realme_mt6785 - Gitiles

 /*
  * Universal Flash Storage Host Performance Booster
  *
  * Copyright (C) 2017-2018 Samsung Electronics Co., Ltd.
  *
  * Authors:
  *	Yongmyung Lee <ymhungry.lee@samsung.com>
  *	Jinyoung Choi <j-young.choi@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.
  *
  * The Linux Foundation chooses to take subject only to the GPLv2
  * license terms, and distributes only under these terms.
  */

 #ifndef _UFSHPB_H_
 #define _UFSHPB_H_

 #include <linux/interrupt.h>
 #include <linux/sysfs.h>
 #include <linux/blktrace_api.h>
 #include <linux/blkdev.h>
 #include <scsi/scsi_cmnd.h>
 #include <scsi/scsi_driver.h>

 #include "../../../block/blk.h"
 #include "../../../drivers/scsi/scsi_priv.h"

 /* Version info*/
 #define UFSHPB_VER				0x0200
 #define UFSHPB_DD_VER				0x0208

 /* Constant value*/
 #define MAX_ACTIVE_NUM				2
 #define MAX_INACTIVE_NUM			2

 #define HPB_ENTRY_SIZE				0x08
 #define HPB_ENTREIS_PER_OS_PAGE			(OS_PAGE_SIZE / HPB_ENTRY_SIZE)

 #define RETRY_DELAY_MS				5000

 /* HPB Support Chunk Size */
 #define HPB_4_CHUNK_LEN				1
 #define HPB_32_CHUNK_LEN			8
 #define HPB_512_CHUNK_LEN			128
 #define HPB_MULTI_CHUNK_LOW			9
 #define HPB_MULTI_CHUNK_HIGH			128
 #define MAX_HPB_CONTEXT_ID			0x7f

 /* Description */
 #define UFS_FEATURE_SUPPORT_HPB_BIT		0x80

 /* Response UPIU types */
 #define HPB_RSP_NONE				0x00
 #define HPB_RSP_REQ_REGION_UPDATE		0x01

 /* Vender defined OPCODE */
 #define UFSHPB_READ_BUFFER			0xF9
 #define UFSHPB_WRITE_BUFFER			0xFA

 #define UFSHPB_GROUP_NUMBER			0x11
 #define UFSHPB_READ_BUFFER_ID			0x01
 #define UFSHPB_WRITE_BUFFER_ID			0x02
 #define TRANSFER_LEN				0x01

 #define DEV_DATA_SEG_LEN			0x14
 #define DEV_SENSE_SEG_LEN			0x12
 #define DEV_DES_TYPE				0x80
 #define DEV_ADDITIONAL_LEN			0x10

 /* For read10 debug */
 #define READ10_DEBUG_LUN			0x7F
 #define READ10_DEBUG_LBA			0x48504230

 /*
  * UFSHPB DEBUG
  */

 #define HPB_DEBUG(hpb, msg, args...)			\
 	do { if (hpb->debug)				\
 		printk(KERN_ERR "%s:%d " msg "\n",	\
 		       __func__, __LINE__, ##args);	\
 	} while (0)

 #define TMSG_CMD(hpb, msg, rq, rgn, srgn)				\
 	do { if (hpb->ufsf->sdev_ufs_lu[hpb->lun] &&			\
 		 hpb->ufsf->sdev_ufs_lu[hpb->lun]->request_queue)	\
 			blk_add_trace_msg(				\
 			hpb->ufsf->sdev_ufs_lu[hpb->lun]->request_queue,\
 			"%llu + %u " msg " %d - %d",			\
 			(unsigned long long) blk_rq_pos(rq),		\
 			(unsigned int) blk_rq_sectors(rq), rgn, srgn);	\
 	} while (0)

 enum UFSHPB_STATE {
 	HPB_PRESENT = 1,
 	HPB_NOT_SUPPORTED = -1,
 	HPB_FAILED = -2,
 	HPB_NEED_INIT = 0,
 	HPB_RESET = -3,
 };

 enum HPBREGION_STATE {
 	HPBREGION_INACTIVE, HPBREGION_ACTIVE, HPBREGION_PINNED,
 };

 enum HPBSUBREGION_STATE {
 	HPBSUBREGION_UNUSED,
 	HPBSUBREGION_DIRTY,
 	HPBSUBREGION_CLEAN,
 	HPBSUBREGION_ISSUED,
 };

 struct ufshpb_dev_info {
 	bool hpb_device;
 	int hpb_number_lu;
 	int hpb_ver;
 	int hpb_rgn_size;
 	int hpb_srgn_size;
 	int hpb_device_max_active_rgns;
 };

 struct ufshpb_active_field {
 	__be16 active_rgn;
 	__be16 active_srgn;
 };

 struct ufshpb_rsp_field {
 	__be16 sense_data_len;
 	u8 desc_type;
 	u8 additional_len;
 	u8 hpb_type;
 	u8 reserved;
 	u8 active_rgn_cnt;
 	u8 inactive_rgn_cnt;
 	struct ufshpb_active_field hpb_active_field[2];
 	__be16 hpb_inactive_field[2];
 };

 struct ufshpb_map_ctx {
 	struct page **m_page;
 	unsigned int *ppn_dirty;

 	struct list_head list_table;
 };

 struct ufshpb_subregion {
 	struct ufshpb_map_ctx *mctx;
 	enum HPBSUBREGION_STATE srgn_state;
 	int rgn_idx;
 	int srgn_idx;

 	/* below information is used by rsp_list */
 	struct list_head list_act_srgn;
 };

 struct ufshpb_region {
 	struct ufshpb_subregion *srgn_tbl;
 	enum HPBREGION_STATE rgn_state;
 	int rgn_idx;
 	int srgn_cnt;

 	/* below information is used by rsp_list */
 	struct list_head list_inact_rgn;

 	/* below information is used by lru */
 	struct list_head list_lru_rgn;
 };

 struct ufshpb_req {
 	struct request *req;
 	struct bio *bio;
 	struct ufshpb_lu *hpb;
 	struct list_head list_req;
 	void (*end_io)(struct request *rq, int err);
 	void *end_io_data;
 	char sense[SCSI_SENSE_BUFFERSIZE];

 	union {
 		struct {
 			struct ufshpb_map_ctx *mctx;
 			unsigned int rgn_idx;
 			unsigned int srgn_idx;
 			unsigned int lun;
 		} rb;
 		struct {
 			struct page *m_page;
 			unsigned int len;
 			unsigned long lpn;
 		} wb;
 	};
 };

 enum selection_type {
 	LRU = 1,
 };

 struct victim_select_info {
 	int selection_type;
 	struct list_head lh_lru_rgn;
 	int max_lru_active_cnt; /* supported hpb #region - pinned #region */
 	atomic64_t active_cnt;
 };

 struct ufshpb_lu {
 	struct ufsf_feature *ufsf;
 	u8 lun;
 	int qd;
 	struct ufshpb_region *rgn_tbl;

 	spinlock_t hpb_lock;

 	struct ufshpb_req *map_req;
 	int num_inflight_map_req;
 	int throttle_map_req;
 	struct list_head lh_map_req_free;
 	struct list_head lh_map_req_retry;
 	struct list_head lh_map_ctx_free;

 	spinlock_t rsp_list_lock;
 	struct list_head lh_pinned_srgn;
 	struct list_head lh_act_srgn;
 	struct list_head lh_inact_rgn;

 	struct kobject kobj;
 	struct mutex sysfs_lock;
 	struct ufshpb_sysfs_entry *sysfs_entries;

 	struct ufshpb_req *pre_req;
 	int num_inflight_pre_req;
 	int throttle_pre_req;
 	struct list_head lh_pre_req_free;
 	struct list_head lh_pre_req_dummy; /* dummy for blk_start_requests() */
 	int ctx_id_ticket;
 	int pre_req_min_tr_len;
 	int pre_req_max_tr_len;

 	struct work_struct ufshpb_work;
 	struct delayed_work ufshpb_retry_work;
 	struct work_struct ufshpb_task_workq;

 	/* for selecting victim */
 	struct victim_select_info lru_info;

 	int hpb_ver;
 	int lu_max_active_rgns;
 	int lu_pinned_rgn_startidx;
 	int lu_pinned_end_offset;
 	int lu_num_pinned_rgns;
 	int srgns_per_lu;
 	int rgns_per_lu;
 	int srgns_per_rgn;
 	int srgn_mem_size;
 	int entries_per_rgn_shift;
 	int entries_per_rgn_mask;
 	int entries_per_srgn;
 	int entries_per_srgn_shift;
 	int entries_per_srgn_mask;
 	int dwords_per_srgn;
 	unsigned long long srgn_unit_size;
 	int mpage_bytes;
 	int mpages_per_srgn;
 	int lu_num_blocks;

 	/* for debug */
 	int alloc_mctx;
 	int debug_free_table;
 	bool force_disable;
 	bool force_map_req_disable;
 	bool debug;
 	atomic64_t hit;
 	atomic64_t miss;
 	atomic64_t rb_noti_cnt;
 	atomic64_t rb_active_cnt;
 	atomic64_t rb_inactive_cnt;
 	atomic64_t map_req_cnt;
 	atomic64_t pre_req_cnt;
 	unsigned long lpn_last;
 };

 struct ufshpb_sysfs_entry {
 	struct attribute    attr;
 	ssize_t (*show)(struct ufshpb_lu *hpb, char *buf);
 	ssize_t (*store)(struct ufshpb_lu *hpb, const char *, size_t);
 };

 struct ufs_hba;
 struct ufshcd_lrb;

 int ufshpb_prepare_pre_req(struct ufsf_feature *ufsf, struct scsi_cmnd *cmd,
 			   u8 lun);
 int ufshpb_prepare_add_lrbp(struct ufsf_feature *ufsf, int add_tag);
 void ufshpb_end_pre_req(struct ufsf_feature *ufsf, struct request *req);
 void ufshpb_get_dev_info(struct ufshpb_dev_info *hpb_dev_info, u8 *desc_buf);
 void ufshpb_get_geo_info(struct ufshpb_dev_info *hpb_dev_info, u8 *geo_buf);
 int ufshpb_get_lu_info(struct ufsf_feature *ufsf, u8 lun, u8 *unit_buf);
 void ufshpb_init_handler(struct work_struct *work);
 void ufshpb_reset_handler(struct work_struct *work);
 void ufshpb_prep_fn(struct ufsf_feature *ufsf, struct ufshcd_lrb *lrbp);
 void ufshpb_rsp_upiu(struct ufsf_feature *ufsf, struct ufshcd_lrb *lrbp);
 void ufshpb_release(struct ufsf_feature *ufsf, int state);
 int ufshpb_issue_req_dev_ctx(struct ufshpb_lu *hpb, unsigned char *buf,
 			     int buf_length);
 void ufshpb_resume(struct ufsf_feature *ufsf);
 void ufshpb_suspend(struct ufsf_feature *ufsf);
 #endif /* End of Header */
	/*
	* Universal Flash Storage Host Performance Booster
	*
	* Copyright (C) 2017-2018 Samsung Electronics Co., Ltd.
	*
	* Authors:
	* Yongmyung Lee <ymhungry.lee@samsung.com>
	* Jinyoung Choi <j-young.choi@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.
	*
	* The Linux Foundation chooses to take subject only to the GPLv2
	* license terms, and distributes only under these terms.
	*/

	#ifndef _UFSHPB_H_
	#define _UFSHPB_H_

	#include <linux/interrupt.h>
	#include <linux/sysfs.h>
	#include <linux/blktrace_api.h>
	#include <linux/blkdev.h>
	#include <scsi/scsi_cmnd.h>
	#include <scsi/scsi_driver.h>

	#include "../../../block/blk.h"
	#include "../../../drivers/scsi/scsi_priv.h"

	/* Version info*/
	#define UFSHPB_VER 0x0200
	#define UFSHPB_DD_VER 0x0208

	/* Constant value*/
	#define MAX_ACTIVE_NUM 2
	#define MAX_INACTIVE_NUM 2

	#define HPB_ENTRY_SIZE 0x08
	#define HPB_ENTREIS_PER_OS_PAGE (OS_PAGE_SIZE / HPB_ENTRY_SIZE)

	#define RETRY_DELAY_MS 5000

	/* HPB Support Chunk Size */
	#define HPB_4_CHUNK_LEN 1
	#define HPB_32_CHUNK_LEN 8
	#define HPB_512_CHUNK_LEN 128
	#define HPB_MULTI_CHUNK_LOW 9
	#define HPB_MULTI_CHUNK_HIGH 128
	#define MAX_HPB_CONTEXT_ID 0x7f

	/* Description */
	#define UFS_FEATURE_SUPPORT_HPB_BIT 0x80

	/* Response UPIU types */
	#define HPB_RSP_NONE 0x00
	#define HPB_RSP_REQ_REGION_UPDATE 0x01

	/* Vender defined OPCODE */
	#define UFSHPB_READ_BUFFER 0xF9
	#define UFSHPB_WRITE_BUFFER 0xFA

	#define UFSHPB_GROUP_NUMBER 0x11
	#define UFSHPB_READ_BUFFER_ID 0x01
	#define UFSHPB_WRITE_BUFFER_ID 0x02
	#define TRANSFER_LEN 0x01

	#define DEV_DATA_SEG_LEN 0x14
	#define DEV_SENSE_SEG_LEN 0x12
	#define DEV_DES_TYPE 0x80
	#define DEV_ADDITIONAL_LEN 0x10

	/* For read10 debug */
	#define READ10_DEBUG_LUN 0x7F
	#define READ10_DEBUG_LBA 0x48504230

	/*
	* UFSHPB DEBUG
	*/

	#define HPB_DEBUG(hpb, msg, args...) \
	do { if (hpb->debug) \
	printk(KERN_ERR "%s:%d " msg "\n", \
	__func__, __LINE__, ##args); \
	} while (0)

	#define TMSG_CMD(hpb, msg, rq, rgn, srgn) \
	do { if (hpb->ufsf->sdev_ufs_lu[hpb->lun] && \
	hpb->ufsf->sdev_ufs_lu[hpb->lun]->request_queue) \
	blk_add_trace_msg( \
	hpb->ufsf->sdev_ufs_lu[hpb->lun]->request_queue,\
	"%llu + %u " msg " %d - %d", \
	(unsigned long long) blk_rq_pos(rq), \
	(unsigned int) blk_rq_sectors(rq), rgn, srgn); \
	} while (0)

	enum UFSHPB_STATE {
	HPB_PRESENT = 1,
	HPB_NOT_SUPPORTED = -1,
	HPB_FAILED = -2,
	HPB_NEED_INIT = 0,
	HPB_RESET = -3,
	};

	enum HPBREGION_STATE {
	HPBREGION_INACTIVE, HPBREGION_ACTIVE, HPBREGION_PINNED,
	};

	enum HPBSUBREGION_STATE {
	HPBSUBREGION_UNUSED,
	HPBSUBREGION_DIRTY,
	HPBSUBREGION_CLEAN,
	HPBSUBREGION_ISSUED,
	};

	struct ufshpb_dev_info {
	bool hpb_device;
	int hpb_number_lu;
	int hpb_ver;
	int hpb_rgn_size;
	int hpb_srgn_size;
	int hpb_device_max_active_rgns;
	};

	struct ufshpb_active_field {
	__be16 active_rgn;
	__be16 active_srgn;
	};

	struct ufshpb_rsp_field {
	__be16 sense_data_len;
	u8 desc_type;
	u8 additional_len;
	u8 hpb_type;
	u8 reserved;
	u8 active_rgn_cnt;
	u8 inactive_rgn_cnt;
	struct ufshpb_active_field hpb_active_field[2];
	__be16 hpb_inactive_field[2];
	};

	struct ufshpb_map_ctx {
	struct page **m_page;
	unsigned int *ppn_dirty;

	struct list_head list_table;
	};

	struct ufshpb_subregion {
	struct ufshpb_map_ctx *mctx;
	enum HPBSUBREGION_STATE srgn_state;
	int rgn_idx;
	int srgn_idx;

	/* below information is used by rsp_list */
	struct list_head list_act_srgn;
	};

	struct ufshpb_region {
	struct ufshpb_subregion *srgn_tbl;
	enum HPBREGION_STATE rgn_state;
	int rgn_idx;
	int srgn_cnt;

	/* below information is used by rsp_list */
	struct list_head list_inact_rgn;

	/* below information is used by lru */
	struct list_head list_lru_rgn;
	};

	struct ufshpb_req {
	struct request *req;
	struct bio *bio;
	struct ufshpb_lu *hpb;
	struct list_head list_req;
	void (end_io)(struct request rq, int err);
	void *end_io_data;
	char sense[SCSI_SENSE_BUFFERSIZE];

	union {
	struct {
	struct ufshpb_map_ctx *mctx;
	unsigned int rgn_idx;
	unsigned int srgn_idx;
	unsigned int lun;
	} rb;
	struct {
	struct page *m_page;
	unsigned int len;
	unsigned long lpn;
	} wb;
	};
	};

	enum selection_type {
	LRU = 1,
	};

	struct victim_select_info {
	int selection_type;
	struct list_head lh_lru_rgn;
	int max_lru_active_cnt; /* supported hpb #region - pinned #region */
	atomic64_t active_cnt;
	};

	struct ufshpb_lu {
	struct ufsf_feature *ufsf;
	u8 lun;
	int qd;
	struct ufshpb_region *rgn_tbl;

	spinlock_t hpb_lock;

	struct ufshpb_req *map_req;
	int num_inflight_map_req;
	int throttle_map_req;
	struct list_head lh_map_req_free;
	struct list_head lh_map_req_retry;
	struct list_head lh_map_ctx_free;

	spinlock_t rsp_list_lock;
	struct list_head lh_pinned_srgn;
	struct list_head lh_act_srgn;
	struct list_head lh_inact_rgn;

	struct kobject kobj;
	struct mutex sysfs_lock;
	struct ufshpb_sysfs_entry *sysfs_entries;

	struct ufshpb_req *pre_req;
	int num_inflight_pre_req;
	int throttle_pre_req;
	struct list_head lh_pre_req_free;
	struct list_head lh_pre_req_dummy; /* dummy for blk_start_requests() */
	int ctx_id_ticket;
	int pre_req_min_tr_len;
	int pre_req_max_tr_len;

	struct work_struct ufshpb_work;
	struct delayed_work ufshpb_retry_work;
	struct work_struct ufshpb_task_workq;

	/* for selecting victim */
	struct victim_select_info lru_info;

	int hpb_ver;
	int lu_max_active_rgns;
	int lu_pinned_rgn_startidx;
	int lu_pinned_end_offset;
	int lu_num_pinned_rgns;
	int srgns_per_lu;
	int rgns_per_lu;
	int srgns_per_rgn;
	int srgn_mem_size;
	int entries_per_rgn_shift;
	int entries_per_rgn_mask;
	int entries_per_srgn;
	int entries_per_srgn_shift;
	int entries_per_srgn_mask;
	int dwords_per_srgn;
	unsigned long long srgn_unit_size;
	int mpage_bytes;
	int mpages_per_srgn;
	int lu_num_blocks;

	/* for debug */
	int alloc_mctx;
	int debug_free_table;
	bool force_disable;
	bool force_map_req_disable;
	bool debug;
	atomic64_t hit;
	atomic64_t miss;
	atomic64_t rb_noti_cnt;
	atomic64_t rb_active_cnt;
	atomic64_t rb_inactive_cnt;
	atomic64_t map_req_cnt;
	atomic64_t pre_req_cnt;
	unsigned long lpn_last;
	};

	struct ufshpb_sysfs_entry {
	struct attribute attr;
	ssize_t (show)(struct ufshpb_lu hpb, char *buf);
	ssize_t (store)(struct ufshpb_lu hpb, const char *, size_t);
	};

	struct ufs_hba;
	struct ufshcd_lrb;

	int ufshpb_prepare_pre_req(struct ufsf_feature ufsf, struct scsi_cmnd cmd,
	u8 lun);
	int ufshpb_prepare_add_lrbp(struct ufsf_feature *ufsf, int add_tag);
	void ufshpb_end_pre_req(struct ufsf_feature ufsf, struct request req);
	void ufshpb_get_dev_info(struct ufshpb_dev_info hpb_dev_info, u8 desc_buf);
	void ufshpb_get_geo_info(struct ufshpb_dev_info hpb_dev_info, u8 geo_buf);
	int ufshpb_get_lu_info(struct ufsf_feature ufsf, u8 lun, u8 unit_buf);
	void ufshpb_init_handler(struct work_struct *work);
	void ufshpb_reset_handler(struct work_struct *work);
	void ufshpb_prep_fn(struct ufsf_feature ufsf, struct ufshcd_lrb lrbp);
	void ufshpb_rsp_upiu(struct ufsf_feature ufsf, struct ufshcd_lrb lrbp);
	void ufshpb_release(struct ufsf_feature *ufsf, int state);
	int ufshpb_issue_req_dev_ctx(struct ufshpb_lu hpb, unsigned char buf,
	int buf_length);
	void ufshpb_resume(struct ufsf_feature *ufsf);
	void ufshpb_suspend(struct ufsf_feature *ufsf);
	#endif /* End of Header */