18c2ecf20Sopenharmony_ci/* SPDX-License-Identifier: GPL-2.0 */
28c2ecf20Sopenharmony_ci/*
38c2ecf20Sopenharmony_ci * Copyright (C) 2015 IT University of Copenhagen (rrpc.h)
48c2ecf20Sopenharmony_ci * Copyright (C) 2016 CNEX Labs
58c2ecf20Sopenharmony_ci * Initial release: Matias Bjorling <matias@cnexlabs.com>
68c2ecf20Sopenharmony_ci * Write buffering: Javier Gonzalez <javier@cnexlabs.com>
78c2ecf20Sopenharmony_ci *
88c2ecf20Sopenharmony_ci * This program is free software; you can redistribute it and/or
98c2ecf20Sopenharmony_ci * modify it under the terms of the GNU General Public License version
108c2ecf20Sopenharmony_ci * 2 as published by the Free Software Foundation.
118c2ecf20Sopenharmony_ci *
128c2ecf20Sopenharmony_ci * This program is distributed in the hope that it will be useful, but
138c2ecf20Sopenharmony_ci * WITHOUT ANY WARRANTY; without even the implied warranty of
148c2ecf20Sopenharmony_ci * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
158c2ecf20Sopenharmony_ci * General Public License for more details.
168c2ecf20Sopenharmony_ci *
178c2ecf20Sopenharmony_ci * Implementation of a Physical Block-device target for Open-channel SSDs.
188c2ecf20Sopenharmony_ci *
198c2ecf20Sopenharmony_ci */
208c2ecf20Sopenharmony_ci
218c2ecf20Sopenharmony_ci#ifndef PBLK_H_
228c2ecf20Sopenharmony_ci#define PBLK_H_
238c2ecf20Sopenharmony_ci
248c2ecf20Sopenharmony_ci#include <linux/blkdev.h>
258c2ecf20Sopenharmony_ci#include <linux/blk-mq.h>
268c2ecf20Sopenharmony_ci#include <linux/bio.h>
278c2ecf20Sopenharmony_ci#include <linux/module.h>
288c2ecf20Sopenharmony_ci#include <linux/kthread.h>
298c2ecf20Sopenharmony_ci#include <linux/vmalloc.h>
308c2ecf20Sopenharmony_ci#include <linux/crc32.h>
318c2ecf20Sopenharmony_ci#include <linux/uuid.h>
328c2ecf20Sopenharmony_ci
338c2ecf20Sopenharmony_ci#include <linux/lightnvm.h>
348c2ecf20Sopenharmony_ci
358c2ecf20Sopenharmony_ci/* Run only GC if less than 1/X blocks are free */
368c2ecf20Sopenharmony_ci#define GC_LIMIT_INVERSE 5
378c2ecf20Sopenharmony_ci#define GC_TIME_MSECS 1000
388c2ecf20Sopenharmony_ci
398c2ecf20Sopenharmony_ci#define PBLK_SECTOR (512)
408c2ecf20Sopenharmony_ci#define PBLK_EXPOSED_PAGE_SIZE (4096)
418c2ecf20Sopenharmony_ci
428c2ecf20Sopenharmony_ci#define PBLK_NR_CLOSE_JOBS (4)
438c2ecf20Sopenharmony_ci
448c2ecf20Sopenharmony_ci#define PBLK_CACHE_NAME_LEN (DISK_NAME_LEN + 16)
458c2ecf20Sopenharmony_ci
468c2ecf20Sopenharmony_ci/* Max 512 LUNs per device */
478c2ecf20Sopenharmony_ci#define PBLK_MAX_LUNS_BITMAP (4)
488c2ecf20Sopenharmony_ci
498c2ecf20Sopenharmony_ci#define NR_PHY_IN_LOG (PBLK_EXPOSED_PAGE_SIZE / PBLK_SECTOR)
508c2ecf20Sopenharmony_ci
518c2ecf20Sopenharmony_ci/* Static pool sizes */
528c2ecf20Sopenharmony_ci#define PBLK_GEN_WS_POOL_SIZE (2)
538c2ecf20Sopenharmony_ci
548c2ecf20Sopenharmony_ci#define PBLK_DEFAULT_OP (11)
558c2ecf20Sopenharmony_ci
568c2ecf20Sopenharmony_cienum {
578c2ecf20Sopenharmony_ci	PBLK_READ		= READ,
588c2ecf20Sopenharmony_ci	PBLK_WRITE		= WRITE,/* Write from write buffer */
598c2ecf20Sopenharmony_ci	PBLK_WRITE_INT,			/* Internal write - no write buffer */
608c2ecf20Sopenharmony_ci	PBLK_READ_RECOV,		/* Recovery read - errors allowed */
618c2ecf20Sopenharmony_ci	PBLK_ERASE,
628c2ecf20Sopenharmony_ci};
638c2ecf20Sopenharmony_ci
648c2ecf20Sopenharmony_cienum {
658c2ecf20Sopenharmony_ci	/* IO Types */
668c2ecf20Sopenharmony_ci	PBLK_IOTYPE_USER	= 1 << 0,
678c2ecf20Sopenharmony_ci	PBLK_IOTYPE_GC		= 1 << 1,
688c2ecf20Sopenharmony_ci
698c2ecf20Sopenharmony_ci	/* Write buffer flags */
708c2ecf20Sopenharmony_ci	PBLK_FLUSH_ENTRY	= 1 << 2,
718c2ecf20Sopenharmony_ci	PBLK_WRITTEN_DATA	= 1 << 3,
728c2ecf20Sopenharmony_ci	PBLK_SUBMITTED_ENTRY	= 1 << 4,
738c2ecf20Sopenharmony_ci	PBLK_WRITABLE_ENTRY	= 1 << 5,
748c2ecf20Sopenharmony_ci};
758c2ecf20Sopenharmony_ci
768c2ecf20Sopenharmony_cienum {
778c2ecf20Sopenharmony_ci	PBLK_BLK_ST_OPEN =	0x1,
788c2ecf20Sopenharmony_ci	PBLK_BLK_ST_CLOSED =	0x2,
798c2ecf20Sopenharmony_ci};
808c2ecf20Sopenharmony_ci
818c2ecf20Sopenharmony_cienum {
828c2ecf20Sopenharmony_ci	PBLK_CHUNK_RESET_START,
838c2ecf20Sopenharmony_ci	PBLK_CHUNK_RESET_DONE,
848c2ecf20Sopenharmony_ci	PBLK_CHUNK_RESET_FAILED,
858c2ecf20Sopenharmony_ci};
868c2ecf20Sopenharmony_ci
878c2ecf20Sopenharmony_cistruct pblk_sec_meta {
888c2ecf20Sopenharmony_ci	u64 reserved;
898c2ecf20Sopenharmony_ci	__le64 lba;
908c2ecf20Sopenharmony_ci};
918c2ecf20Sopenharmony_ci
928c2ecf20Sopenharmony_ci/* The number of GC lists and the rate-limiter states go together. This way the
938c2ecf20Sopenharmony_ci * rate-limiter can dictate how much GC is needed based on resource utilization.
948c2ecf20Sopenharmony_ci */
958c2ecf20Sopenharmony_ci#define PBLK_GC_NR_LISTS 4
968c2ecf20Sopenharmony_ci
978c2ecf20Sopenharmony_cienum {
988c2ecf20Sopenharmony_ci	PBLK_RL_OFF = 0,
998c2ecf20Sopenharmony_ci	PBLK_RL_WERR = 1,
1008c2ecf20Sopenharmony_ci	PBLK_RL_HIGH = 2,
1018c2ecf20Sopenharmony_ci	PBLK_RL_MID = 3,
1028c2ecf20Sopenharmony_ci	PBLK_RL_LOW = 4
1038c2ecf20Sopenharmony_ci};
1048c2ecf20Sopenharmony_ci
1058c2ecf20Sopenharmony_ci#define pblk_dma_ppa_size (sizeof(u64) * NVM_MAX_VLBA)
1068c2ecf20Sopenharmony_ci
1078c2ecf20Sopenharmony_ci/* write buffer completion context */
1088c2ecf20Sopenharmony_cistruct pblk_c_ctx {
1098c2ecf20Sopenharmony_ci	struct list_head list;		/* Head for out-of-order completion */
1108c2ecf20Sopenharmony_ci
1118c2ecf20Sopenharmony_ci	unsigned long *lun_bitmap;	/* Luns used on current request */
1128c2ecf20Sopenharmony_ci	unsigned int sentry;
1138c2ecf20Sopenharmony_ci	unsigned int nr_valid;
1148c2ecf20Sopenharmony_ci	unsigned int nr_padded;
1158c2ecf20Sopenharmony_ci};
1168c2ecf20Sopenharmony_ci
1178c2ecf20Sopenharmony_ci/* read context */
1188c2ecf20Sopenharmony_cistruct pblk_g_ctx {
1198c2ecf20Sopenharmony_ci	void *private;
1208c2ecf20Sopenharmony_ci	unsigned long start_time;
1218c2ecf20Sopenharmony_ci	u64 lba;
1228c2ecf20Sopenharmony_ci};
1238c2ecf20Sopenharmony_ci
1248c2ecf20Sopenharmony_ci/* Pad context */
1258c2ecf20Sopenharmony_cistruct pblk_pad_rq {
1268c2ecf20Sopenharmony_ci	struct pblk *pblk;
1278c2ecf20Sopenharmony_ci	struct completion wait;
1288c2ecf20Sopenharmony_ci	struct kref ref;
1298c2ecf20Sopenharmony_ci};
1308c2ecf20Sopenharmony_ci
1318c2ecf20Sopenharmony_ci/* Recovery context */
1328c2ecf20Sopenharmony_cistruct pblk_rec_ctx {
1338c2ecf20Sopenharmony_ci	struct pblk *pblk;
1348c2ecf20Sopenharmony_ci	struct nvm_rq *rqd;
1358c2ecf20Sopenharmony_ci	struct work_struct ws_rec;
1368c2ecf20Sopenharmony_ci};
1378c2ecf20Sopenharmony_ci
1388c2ecf20Sopenharmony_ci/* Write context */
1398c2ecf20Sopenharmony_cistruct pblk_w_ctx {
1408c2ecf20Sopenharmony_ci	struct bio_list bios;		/* Original bios - used for completion
1418c2ecf20Sopenharmony_ci					 * in REQ_FUA, REQ_FLUSH case
1428c2ecf20Sopenharmony_ci					 */
1438c2ecf20Sopenharmony_ci	u64 lba;			/* Logic addr. associated with entry */
1448c2ecf20Sopenharmony_ci	struct ppa_addr ppa;		/* Physic addr. associated with entry */
1458c2ecf20Sopenharmony_ci	int flags;			/* Write context flags */
1468c2ecf20Sopenharmony_ci};
1478c2ecf20Sopenharmony_ci
1488c2ecf20Sopenharmony_cistruct pblk_rb_entry {
1498c2ecf20Sopenharmony_ci	struct ppa_addr cacheline;	/* Cacheline for this entry */
1508c2ecf20Sopenharmony_ci	void *data;			/* Pointer to data on this entry */
1518c2ecf20Sopenharmony_ci	struct pblk_w_ctx w_ctx;	/* Context for this entry */
1528c2ecf20Sopenharmony_ci	struct list_head index;		/* List head to enable indexes */
1538c2ecf20Sopenharmony_ci};
1548c2ecf20Sopenharmony_ci
1558c2ecf20Sopenharmony_ci#define EMPTY_ENTRY (~0U)
1568c2ecf20Sopenharmony_ci
1578c2ecf20Sopenharmony_cistruct pblk_rb_pages {
1588c2ecf20Sopenharmony_ci	struct page *pages;
1598c2ecf20Sopenharmony_ci	int order;
1608c2ecf20Sopenharmony_ci	struct list_head list;
1618c2ecf20Sopenharmony_ci};
1628c2ecf20Sopenharmony_ci
1638c2ecf20Sopenharmony_cistruct pblk_rb {
1648c2ecf20Sopenharmony_ci	struct pblk_rb_entry *entries;	/* Ring buffer entries */
1658c2ecf20Sopenharmony_ci	unsigned int mem;		/* Write offset - points to next
1668c2ecf20Sopenharmony_ci					 * writable entry in memory
1678c2ecf20Sopenharmony_ci					 */
1688c2ecf20Sopenharmony_ci	unsigned int subm;		/* Read offset - points to last entry
1698c2ecf20Sopenharmony_ci					 * that has been submitted to the media
1708c2ecf20Sopenharmony_ci					 * to be persisted
1718c2ecf20Sopenharmony_ci					 */
1728c2ecf20Sopenharmony_ci	unsigned int sync;		/* Synced - backpointer that signals
1738c2ecf20Sopenharmony_ci					 * the last submitted entry that has
1748c2ecf20Sopenharmony_ci					 * been successfully persisted to media
1758c2ecf20Sopenharmony_ci					 */
1768c2ecf20Sopenharmony_ci	unsigned int flush_point;	/* Sync point - last entry that must be
1778c2ecf20Sopenharmony_ci					 * flushed to the media. Used with
1788c2ecf20Sopenharmony_ci					 * REQ_FLUSH and REQ_FUA
1798c2ecf20Sopenharmony_ci					 */
1808c2ecf20Sopenharmony_ci	unsigned int l2p_update;	/* l2p update point - next entry for
1818c2ecf20Sopenharmony_ci					 * which l2p mapping will be updated to
1828c2ecf20Sopenharmony_ci					 * contain a device ppa address (instead
1838c2ecf20Sopenharmony_ci					 * of a cacheline
1848c2ecf20Sopenharmony_ci					 */
1858c2ecf20Sopenharmony_ci	unsigned int nr_entries;	/* Number of entries in write buffer -
1868c2ecf20Sopenharmony_ci					 * must be a power of two
1878c2ecf20Sopenharmony_ci					 */
1888c2ecf20Sopenharmony_ci	unsigned int seg_size;		/* Size of the data segments being
1898c2ecf20Sopenharmony_ci					 * stored on each entry. Typically this
1908c2ecf20Sopenharmony_ci					 * will be 4KB
1918c2ecf20Sopenharmony_ci					 */
1928c2ecf20Sopenharmony_ci
1938c2ecf20Sopenharmony_ci	unsigned int back_thres;	/* Threshold that shall be maintained by
1948c2ecf20Sopenharmony_ci					 * the backpointer in order to respect
1958c2ecf20Sopenharmony_ci					 * geo->mw_cunits on a per chunk basis
1968c2ecf20Sopenharmony_ci					 */
1978c2ecf20Sopenharmony_ci
1988c2ecf20Sopenharmony_ci	struct list_head pages;		/* List of data pages */
1998c2ecf20Sopenharmony_ci
2008c2ecf20Sopenharmony_ci	spinlock_t w_lock;		/* Write lock */
2018c2ecf20Sopenharmony_ci	spinlock_t s_lock;		/* Sync lock */
2028c2ecf20Sopenharmony_ci
2038c2ecf20Sopenharmony_ci#ifdef CONFIG_NVM_PBLK_DEBUG
2048c2ecf20Sopenharmony_ci	atomic_t inflight_flush_point;	/* Not served REQ_FLUSH | REQ_FUA */
2058c2ecf20Sopenharmony_ci#endif
2068c2ecf20Sopenharmony_ci};
2078c2ecf20Sopenharmony_ci
2088c2ecf20Sopenharmony_ci#define PBLK_RECOVERY_SECTORS 16
2098c2ecf20Sopenharmony_ci
2108c2ecf20Sopenharmony_cistruct pblk_lun {
2118c2ecf20Sopenharmony_ci	struct ppa_addr bppa;
2128c2ecf20Sopenharmony_ci	struct semaphore wr_sem;
2138c2ecf20Sopenharmony_ci};
2148c2ecf20Sopenharmony_ci
2158c2ecf20Sopenharmony_cistruct pblk_gc_rq {
2168c2ecf20Sopenharmony_ci	struct pblk_line *line;
2178c2ecf20Sopenharmony_ci	void *data;
2188c2ecf20Sopenharmony_ci	u64 paddr_list[NVM_MAX_VLBA];
2198c2ecf20Sopenharmony_ci	u64 lba_list[NVM_MAX_VLBA];
2208c2ecf20Sopenharmony_ci	int nr_secs;
2218c2ecf20Sopenharmony_ci	int secs_to_gc;
2228c2ecf20Sopenharmony_ci	struct list_head list;
2238c2ecf20Sopenharmony_ci};
2248c2ecf20Sopenharmony_ci
2258c2ecf20Sopenharmony_cistruct pblk_gc {
2268c2ecf20Sopenharmony_ci	/* These states are not protected by a lock since (i) they are in the
2278c2ecf20Sopenharmony_ci	 * fast path, and (ii) they are not critical.
2288c2ecf20Sopenharmony_ci	 */
2298c2ecf20Sopenharmony_ci	int gc_active;
2308c2ecf20Sopenharmony_ci	int gc_enabled;
2318c2ecf20Sopenharmony_ci	int gc_forced;
2328c2ecf20Sopenharmony_ci
2338c2ecf20Sopenharmony_ci	struct task_struct *gc_ts;
2348c2ecf20Sopenharmony_ci	struct task_struct *gc_writer_ts;
2358c2ecf20Sopenharmony_ci	struct task_struct *gc_reader_ts;
2368c2ecf20Sopenharmony_ci
2378c2ecf20Sopenharmony_ci	struct workqueue_struct *gc_line_reader_wq;
2388c2ecf20Sopenharmony_ci	struct workqueue_struct *gc_reader_wq;
2398c2ecf20Sopenharmony_ci
2408c2ecf20Sopenharmony_ci	struct timer_list gc_timer;
2418c2ecf20Sopenharmony_ci
2428c2ecf20Sopenharmony_ci	struct semaphore gc_sem;
2438c2ecf20Sopenharmony_ci	atomic_t read_inflight_gc; /* Number of lines with inflight GC reads */
2448c2ecf20Sopenharmony_ci	atomic_t pipeline_gc;	   /* Number of lines in the GC pipeline -
2458c2ecf20Sopenharmony_ci				    * started reads to finished writes
2468c2ecf20Sopenharmony_ci				    */
2478c2ecf20Sopenharmony_ci	int w_entries;
2488c2ecf20Sopenharmony_ci
2498c2ecf20Sopenharmony_ci	struct list_head w_list;
2508c2ecf20Sopenharmony_ci	struct list_head r_list;
2518c2ecf20Sopenharmony_ci
2528c2ecf20Sopenharmony_ci	spinlock_t lock;
2538c2ecf20Sopenharmony_ci	spinlock_t w_lock;
2548c2ecf20Sopenharmony_ci	spinlock_t r_lock;
2558c2ecf20Sopenharmony_ci};
2568c2ecf20Sopenharmony_ci
2578c2ecf20Sopenharmony_cistruct pblk_rl {
2588c2ecf20Sopenharmony_ci	unsigned int high;	/* Upper threshold for rate limiter (free run -
2598c2ecf20Sopenharmony_ci				 * user I/O rate limiter
2608c2ecf20Sopenharmony_ci				 */
2618c2ecf20Sopenharmony_ci	unsigned int high_pw;	/* High rounded up as a power of 2 */
2628c2ecf20Sopenharmony_ci
2638c2ecf20Sopenharmony_ci#define PBLK_USER_HIGH_THRS 8	/* Begin write limit at 12% available blks */
2648c2ecf20Sopenharmony_ci#define PBLK_USER_LOW_THRS 10	/* Aggressive GC at 10% available blocks */
2658c2ecf20Sopenharmony_ci
2668c2ecf20Sopenharmony_ci	int rb_windows_pw;	/* Number of rate windows in the write buffer
2678c2ecf20Sopenharmony_ci				 * given as a power-of-2. This guarantees that
2688c2ecf20Sopenharmony_ci				 * when user I/O is being rate limited, there
2698c2ecf20Sopenharmony_ci				 * will be reserved enough space for the GC to
2708c2ecf20Sopenharmony_ci				 * place its payload. A window is of
2718c2ecf20Sopenharmony_ci				 * pblk->max_write_pgs size, which in NVMe is
2728c2ecf20Sopenharmony_ci				 * 64, i.e., 256kb.
2738c2ecf20Sopenharmony_ci				 */
2748c2ecf20Sopenharmony_ci	int rb_budget;		/* Total number of entries available for I/O */
2758c2ecf20Sopenharmony_ci	int rb_user_max;	/* Max buffer entries available for user I/O */
2768c2ecf20Sopenharmony_ci	int rb_gc_max;		/* Max buffer entries available for GC I/O */
2778c2ecf20Sopenharmony_ci	int rb_gc_rsv;		/* Reserved buffer entries for GC I/O */
2788c2ecf20Sopenharmony_ci	int rb_state;		/* Rate-limiter current state */
2798c2ecf20Sopenharmony_ci	int rb_max_io;		/* Maximum size for an I/O giving the config */
2808c2ecf20Sopenharmony_ci
2818c2ecf20Sopenharmony_ci	atomic_t rb_user_cnt;	/* User I/O buffer counter */
2828c2ecf20Sopenharmony_ci	atomic_t rb_gc_cnt;	/* GC I/O buffer counter */
2838c2ecf20Sopenharmony_ci	atomic_t rb_space;	/* Space limit in case of reaching capacity */
2848c2ecf20Sopenharmony_ci
2858c2ecf20Sopenharmony_ci	int rsv_blocks;		/* Reserved blocks for GC */
2868c2ecf20Sopenharmony_ci
2878c2ecf20Sopenharmony_ci	int rb_user_active;
2888c2ecf20Sopenharmony_ci	int rb_gc_active;
2898c2ecf20Sopenharmony_ci
2908c2ecf20Sopenharmony_ci	atomic_t werr_lines;	/* Number of write error lines that needs gc */
2918c2ecf20Sopenharmony_ci
2928c2ecf20Sopenharmony_ci	struct timer_list u_timer;
2938c2ecf20Sopenharmony_ci
2948c2ecf20Sopenharmony_ci	unsigned long total_blocks;
2958c2ecf20Sopenharmony_ci
2968c2ecf20Sopenharmony_ci	atomic_t free_blocks;		/* Total number of free blocks (+ OP) */
2978c2ecf20Sopenharmony_ci	atomic_t free_user_blocks;	/* Number of user free blocks (no OP) */
2988c2ecf20Sopenharmony_ci};
2998c2ecf20Sopenharmony_ci
3008c2ecf20Sopenharmony_ci#define PBLK_LINE_EMPTY (~0U)
3018c2ecf20Sopenharmony_ci
3028c2ecf20Sopenharmony_cienum {
3038c2ecf20Sopenharmony_ci	/* Line Types */
3048c2ecf20Sopenharmony_ci	PBLK_LINETYPE_FREE = 0,
3058c2ecf20Sopenharmony_ci	PBLK_LINETYPE_LOG = 1,
3068c2ecf20Sopenharmony_ci	PBLK_LINETYPE_DATA = 2,
3078c2ecf20Sopenharmony_ci
3088c2ecf20Sopenharmony_ci	/* Line state */
3098c2ecf20Sopenharmony_ci	PBLK_LINESTATE_NEW = 9,
3108c2ecf20Sopenharmony_ci	PBLK_LINESTATE_FREE = 10,
3118c2ecf20Sopenharmony_ci	PBLK_LINESTATE_OPEN = 11,
3128c2ecf20Sopenharmony_ci	PBLK_LINESTATE_CLOSED = 12,
3138c2ecf20Sopenharmony_ci	PBLK_LINESTATE_GC = 13,
3148c2ecf20Sopenharmony_ci	PBLK_LINESTATE_BAD = 14,
3158c2ecf20Sopenharmony_ci	PBLK_LINESTATE_CORRUPT = 15,
3168c2ecf20Sopenharmony_ci
3178c2ecf20Sopenharmony_ci	/* GC group */
3188c2ecf20Sopenharmony_ci	PBLK_LINEGC_NONE = 20,
3198c2ecf20Sopenharmony_ci	PBLK_LINEGC_EMPTY = 21,
3208c2ecf20Sopenharmony_ci	PBLK_LINEGC_LOW = 22,
3218c2ecf20Sopenharmony_ci	PBLK_LINEGC_MID = 23,
3228c2ecf20Sopenharmony_ci	PBLK_LINEGC_HIGH = 24,
3238c2ecf20Sopenharmony_ci	PBLK_LINEGC_FULL = 25,
3248c2ecf20Sopenharmony_ci	PBLK_LINEGC_WERR = 26
3258c2ecf20Sopenharmony_ci};
3268c2ecf20Sopenharmony_ci
3278c2ecf20Sopenharmony_ci#define PBLK_MAGIC 0x70626c6b /*pblk*/
3288c2ecf20Sopenharmony_ci
3298c2ecf20Sopenharmony_ci/* emeta/smeta persistent storage format versions:
3308c2ecf20Sopenharmony_ci * Changes in major version requires offline migration.
3318c2ecf20Sopenharmony_ci * Changes in minor version are handled automatically during
3328c2ecf20Sopenharmony_ci * recovery.
3338c2ecf20Sopenharmony_ci */
3348c2ecf20Sopenharmony_ci
3358c2ecf20Sopenharmony_ci#define SMETA_VERSION_MAJOR (0)
3368c2ecf20Sopenharmony_ci#define SMETA_VERSION_MINOR (1)
3378c2ecf20Sopenharmony_ci
3388c2ecf20Sopenharmony_ci#define EMETA_VERSION_MAJOR (0)
3398c2ecf20Sopenharmony_ci#define EMETA_VERSION_MINOR (2)
3408c2ecf20Sopenharmony_ci
3418c2ecf20Sopenharmony_cistruct line_header {
3428c2ecf20Sopenharmony_ci	__le32 crc;
3438c2ecf20Sopenharmony_ci	__le32 identifier;	/* pblk identifier */
3448c2ecf20Sopenharmony_ci	__u8 uuid[16];		/* instance uuid */
3458c2ecf20Sopenharmony_ci	__le16 type;		/* line type */
3468c2ecf20Sopenharmony_ci	__u8 version_major;	/* version major */
3478c2ecf20Sopenharmony_ci	__u8 version_minor;	/* version minor */
3488c2ecf20Sopenharmony_ci	__le32 id;		/* line id for current line */
3498c2ecf20Sopenharmony_ci};
3508c2ecf20Sopenharmony_ci
3518c2ecf20Sopenharmony_cistruct line_smeta {
3528c2ecf20Sopenharmony_ci	struct line_header header;
3538c2ecf20Sopenharmony_ci
3548c2ecf20Sopenharmony_ci	__le32 crc;		/* Full structure including struct crc */
3558c2ecf20Sopenharmony_ci	/* Previous line metadata */
3568c2ecf20Sopenharmony_ci	__le32 prev_id;		/* Line id for previous line */
3578c2ecf20Sopenharmony_ci
3588c2ecf20Sopenharmony_ci	/* Current line metadata */
3598c2ecf20Sopenharmony_ci	__le64 seq_nr;		/* Sequence number for current line */
3608c2ecf20Sopenharmony_ci
3618c2ecf20Sopenharmony_ci	/* Active writers */
3628c2ecf20Sopenharmony_ci	__le32 window_wr_lun;	/* Number of parallel LUNs to write */
3638c2ecf20Sopenharmony_ci
3648c2ecf20Sopenharmony_ci	__le32 rsvd[2];
3658c2ecf20Sopenharmony_ci
3668c2ecf20Sopenharmony_ci	__le64 lun_bitmap[];
3678c2ecf20Sopenharmony_ci};
3688c2ecf20Sopenharmony_ci
3698c2ecf20Sopenharmony_ci
3708c2ecf20Sopenharmony_ci/*
3718c2ecf20Sopenharmony_ci * Metadata layout in media:
3728c2ecf20Sopenharmony_ci *	First sector:
3738c2ecf20Sopenharmony_ci *		1. struct line_emeta
3748c2ecf20Sopenharmony_ci *		2. bad block bitmap (u64 * window_wr_lun)
3758c2ecf20Sopenharmony_ci *		3. write amplification counters
3768c2ecf20Sopenharmony_ci *	Mid sectors (start at lbas_sector):
3778c2ecf20Sopenharmony_ci *		3. nr_lbas (u64) forming lba list
3788c2ecf20Sopenharmony_ci *	Last sectors (start at vsc_sector):
3798c2ecf20Sopenharmony_ci *		4. u32 valid sector count (vsc) for all lines (~0U: free line)
3808c2ecf20Sopenharmony_ci */
3818c2ecf20Sopenharmony_cistruct line_emeta {
3828c2ecf20Sopenharmony_ci	struct line_header header;
3838c2ecf20Sopenharmony_ci
3848c2ecf20Sopenharmony_ci	__le32 crc;		/* Full structure including struct crc */
3858c2ecf20Sopenharmony_ci
3868c2ecf20Sopenharmony_ci	/* Previous line metadata */
3878c2ecf20Sopenharmony_ci	__le32 prev_id;		/* Line id for prev line */
3888c2ecf20Sopenharmony_ci
3898c2ecf20Sopenharmony_ci	/* Current line metadata */
3908c2ecf20Sopenharmony_ci	__le64 seq_nr;		/* Sequence number for current line */
3918c2ecf20Sopenharmony_ci
3928c2ecf20Sopenharmony_ci	/* Active writers */
3938c2ecf20Sopenharmony_ci	__le32 window_wr_lun;	/* Number of parallel LUNs to write */
3948c2ecf20Sopenharmony_ci
3958c2ecf20Sopenharmony_ci	/* Bookkeeping for recovery */
3968c2ecf20Sopenharmony_ci	__le32 next_id;		/* Line id for next line */
3978c2ecf20Sopenharmony_ci	__le64 nr_lbas;		/* Number of lbas mapped in line */
3988c2ecf20Sopenharmony_ci	__le64 nr_valid_lbas;	/* Number of valid lbas mapped in line */
3998c2ecf20Sopenharmony_ci	__le64 bb_bitmap[];     /* Updated bad block bitmap for line */
4008c2ecf20Sopenharmony_ci};
4018c2ecf20Sopenharmony_ci
4028c2ecf20Sopenharmony_ci
4038c2ecf20Sopenharmony_ci/* Write amplification counters stored on media */
4048c2ecf20Sopenharmony_cistruct wa_counters {
4058c2ecf20Sopenharmony_ci	__le64 user;		/* Number of user written sectors */
4068c2ecf20Sopenharmony_ci	__le64 gc;		/* Number of sectors written by GC*/
4078c2ecf20Sopenharmony_ci	__le64 pad;		/* Number of padded sectors */
4088c2ecf20Sopenharmony_ci};
4098c2ecf20Sopenharmony_ci
4108c2ecf20Sopenharmony_cistruct pblk_emeta {
4118c2ecf20Sopenharmony_ci	struct line_emeta *buf;		/* emeta buffer in media format */
4128c2ecf20Sopenharmony_ci	int mem;			/* Write offset - points to next
4138c2ecf20Sopenharmony_ci					 * writable entry in memory
4148c2ecf20Sopenharmony_ci					 */
4158c2ecf20Sopenharmony_ci	atomic_t sync;			/* Synced - backpointer that signals the
4168c2ecf20Sopenharmony_ci					 * last entry that has been successfully
4178c2ecf20Sopenharmony_ci					 * persisted to media
4188c2ecf20Sopenharmony_ci					 */
4198c2ecf20Sopenharmony_ci	unsigned int nr_entries;	/* Number of emeta entries */
4208c2ecf20Sopenharmony_ci};
4218c2ecf20Sopenharmony_ci
4228c2ecf20Sopenharmony_cistruct pblk_smeta {
4238c2ecf20Sopenharmony_ci	struct line_smeta *buf;		/* smeta buffer in persistent format */
4248c2ecf20Sopenharmony_ci};
4258c2ecf20Sopenharmony_ci
4268c2ecf20Sopenharmony_cistruct pblk_w_err_gc {
4278c2ecf20Sopenharmony_ci	int has_write_err;
4288c2ecf20Sopenharmony_ci	int has_gc_err;
4298c2ecf20Sopenharmony_ci	__le64 *lba_list;
4308c2ecf20Sopenharmony_ci};
4318c2ecf20Sopenharmony_ci
4328c2ecf20Sopenharmony_cistruct pblk_line {
4338c2ecf20Sopenharmony_ci	struct pblk *pblk;
4348c2ecf20Sopenharmony_ci	unsigned int id;		/* Line number corresponds to the
4358c2ecf20Sopenharmony_ci					 * block line
4368c2ecf20Sopenharmony_ci					 */
4378c2ecf20Sopenharmony_ci	unsigned int seq_nr;		/* Unique line sequence number */
4388c2ecf20Sopenharmony_ci
4398c2ecf20Sopenharmony_ci	int state;			/* PBLK_LINESTATE_X */
4408c2ecf20Sopenharmony_ci	int type;			/* PBLK_LINETYPE_X */
4418c2ecf20Sopenharmony_ci	int gc_group;			/* PBLK_LINEGC_X */
4428c2ecf20Sopenharmony_ci	struct list_head list;		/* Free, GC lists */
4438c2ecf20Sopenharmony_ci
4448c2ecf20Sopenharmony_ci	unsigned long *lun_bitmap;	/* Bitmap for LUNs mapped in line */
4458c2ecf20Sopenharmony_ci
4468c2ecf20Sopenharmony_ci	struct nvm_chk_meta *chks;	/* Chunks forming line */
4478c2ecf20Sopenharmony_ci
4488c2ecf20Sopenharmony_ci	struct pblk_smeta *smeta;	/* Start metadata */
4498c2ecf20Sopenharmony_ci	struct pblk_emeta *emeta;	/* End medatada */
4508c2ecf20Sopenharmony_ci
4518c2ecf20Sopenharmony_ci	int meta_line;			/* Metadata line id */
4528c2ecf20Sopenharmony_ci	int meta_distance;		/* Distance between data and metadata */
4538c2ecf20Sopenharmony_ci
4548c2ecf20Sopenharmony_ci	u64 emeta_ssec;			/* Sector where emeta starts */
4558c2ecf20Sopenharmony_ci
4568c2ecf20Sopenharmony_ci	unsigned int sec_in_line;	/* Number of usable secs in line */
4578c2ecf20Sopenharmony_ci
4588c2ecf20Sopenharmony_ci	atomic_t blk_in_line;		/* Number of good blocks in line */
4598c2ecf20Sopenharmony_ci	unsigned long *blk_bitmap;	/* Bitmap for valid/invalid blocks */
4608c2ecf20Sopenharmony_ci	unsigned long *erase_bitmap;	/* Bitmap for erased blocks */
4618c2ecf20Sopenharmony_ci
4628c2ecf20Sopenharmony_ci	unsigned long *map_bitmap;	/* Bitmap for mapped sectors in line */
4638c2ecf20Sopenharmony_ci	unsigned long *invalid_bitmap;	/* Bitmap for invalid sectors in line */
4648c2ecf20Sopenharmony_ci
4658c2ecf20Sopenharmony_ci	atomic_t left_eblks;		/* Blocks left for erasing */
4668c2ecf20Sopenharmony_ci	atomic_t left_seblks;		/* Blocks left for sync erasing */
4678c2ecf20Sopenharmony_ci
4688c2ecf20Sopenharmony_ci	int left_msecs;			/* Sectors left for mapping */
4698c2ecf20Sopenharmony_ci	unsigned int cur_sec;		/* Sector map pointer */
4708c2ecf20Sopenharmony_ci	unsigned int nr_valid_lbas;	/* Number of valid lbas in line */
4718c2ecf20Sopenharmony_ci
4728c2ecf20Sopenharmony_ci	__le32 *vsc;			/* Valid sector count in line */
4738c2ecf20Sopenharmony_ci
4748c2ecf20Sopenharmony_ci	struct kref ref;		/* Write buffer L2P references */
4758c2ecf20Sopenharmony_ci	atomic_t sec_to_update;         /* Outstanding L2P updates to ppa */
4768c2ecf20Sopenharmony_ci
4778c2ecf20Sopenharmony_ci	struct pblk_w_err_gc *w_err_gc;	/* Write error gc recovery metadata */
4788c2ecf20Sopenharmony_ci
4798c2ecf20Sopenharmony_ci	spinlock_t lock;		/* Necessary for invalid_bitmap only */
4808c2ecf20Sopenharmony_ci};
4818c2ecf20Sopenharmony_ci
4828c2ecf20Sopenharmony_ci#define PBLK_DATA_LINES 4
4838c2ecf20Sopenharmony_ci
4848c2ecf20Sopenharmony_cienum {
4858c2ecf20Sopenharmony_ci	PBLK_EMETA_TYPE_HEADER = 1,	/* struct line_emeta first sector */
4868c2ecf20Sopenharmony_ci	PBLK_EMETA_TYPE_LLBA = 2,	/* lba list - type: __le64 */
4878c2ecf20Sopenharmony_ci	PBLK_EMETA_TYPE_VSC = 3,	/* vsc list - type: __le32 */
4888c2ecf20Sopenharmony_ci};
4898c2ecf20Sopenharmony_ci
4908c2ecf20Sopenharmony_cistruct pblk_line_mgmt {
4918c2ecf20Sopenharmony_ci	int nr_lines;			/* Total number of full lines */
4928c2ecf20Sopenharmony_ci	int nr_free_lines;		/* Number of full lines in free list */
4938c2ecf20Sopenharmony_ci
4948c2ecf20Sopenharmony_ci	/* Free lists - use free_lock */
4958c2ecf20Sopenharmony_ci	struct list_head free_list;	/* Full lines ready to use */
4968c2ecf20Sopenharmony_ci	struct list_head corrupt_list;	/* Full lines corrupted */
4978c2ecf20Sopenharmony_ci	struct list_head bad_list;	/* Full lines bad */
4988c2ecf20Sopenharmony_ci
4998c2ecf20Sopenharmony_ci	/* GC lists - use gc_lock */
5008c2ecf20Sopenharmony_ci	struct list_head *gc_lists[PBLK_GC_NR_LISTS];
5018c2ecf20Sopenharmony_ci	struct list_head gc_high_list;	/* Full lines ready to GC, high isc */
5028c2ecf20Sopenharmony_ci	struct list_head gc_mid_list;	/* Full lines ready to GC, mid isc */
5038c2ecf20Sopenharmony_ci	struct list_head gc_low_list;	/* Full lines ready to GC, low isc */
5048c2ecf20Sopenharmony_ci
5058c2ecf20Sopenharmony_ci	struct list_head gc_werr_list;  /* Write err recovery list */
5068c2ecf20Sopenharmony_ci
5078c2ecf20Sopenharmony_ci	struct list_head gc_full_list;	/* Full lines ready to GC, no valid */
5088c2ecf20Sopenharmony_ci	struct list_head gc_empty_list;	/* Full lines close, all valid */
5098c2ecf20Sopenharmony_ci
5108c2ecf20Sopenharmony_ci	struct pblk_line *log_line;	/* Current FTL log line */
5118c2ecf20Sopenharmony_ci	struct pblk_line *data_line;	/* Current data line */
5128c2ecf20Sopenharmony_ci	struct pblk_line *log_next;	/* Next FTL log line */
5138c2ecf20Sopenharmony_ci	struct pblk_line *data_next;	/* Next data line */
5148c2ecf20Sopenharmony_ci
5158c2ecf20Sopenharmony_ci	struct list_head emeta_list;	/* Lines queued to schedule emeta */
5168c2ecf20Sopenharmony_ci
5178c2ecf20Sopenharmony_ci	__le32 *vsc_list;		/* Valid sector counts for all lines */
5188c2ecf20Sopenharmony_ci
5198c2ecf20Sopenharmony_ci	/* Pre-allocated metadata for data lines */
5208c2ecf20Sopenharmony_ci	struct pblk_smeta *sline_meta[PBLK_DATA_LINES];
5218c2ecf20Sopenharmony_ci	struct pblk_emeta *eline_meta[PBLK_DATA_LINES];
5228c2ecf20Sopenharmony_ci	unsigned long meta_bitmap;
5238c2ecf20Sopenharmony_ci
5248c2ecf20Sopenharmony_ci	/* Cache and mempool for map/invalid bitmaps */
5258c2ecf20Sopenharmony_ci	struct kmem_cache *bitmap_cache;
5268c2ecf20Sopenharmony_ci	mempool_t *bitmap_pool;
5278c2ecf20Sopenharmony_ci
5288c2ecf20Sopenharmony_ci	/* Helpers for fast bitmap calculations */
5298c2ecf20Sopenharmony_ci	unsigned long *bb_template;
5308c2ecf20Sopenharmony_ci	unsigned long *bb_aux;
5318c2ecf20Sopenharmony_ci
5328c2ecf20Sopenharmony_ci	unsigned long d_seq_nr;		/* Data line unique sequence number */
5338c2ecf20Sopenharmony_ci	unsigned long l_seq_nr;		/* Log line unique sequence number */
5348c2ecf20Sopenharmony_ci
5358c2ecf20Sopenharmony_ci	spinlock_t free_lock;
5368c2ecf20Sopenharmony_ci	spinlock_t close_lock;
5378c2ecf20Sopenharmony_ci	spinlock_t gc_lock;
5388c2ecf20Sopenharmony_ci};
5398c2ecf20Sopenharmony_ci
5408c2ecf20Sopenharmony_cistruct pblk_line_meta {
5418c2ecf20Sopenharmony_ci	unsigned int smeta_len;		/* Total length for smeta */
5428c2ecf20Sopenharmony_ci	unsigned int smeta_sec;		/* Sectors needed for smeta */
5438c2ecf20Sopenharmony_ci
5448c2ecf20Sopenharmony_ci	unsigned int emeta_len[4];	/* Lengths for emeta:
5458c2ecf20Sopenharmony_ci					 *  [0]: Total
5468c2ecf20Sopenharmony_ci					 *  [1]: struct line_emeta +
5478c2ecf20Sopenharmony_ci					 *       bb_bitmap + struct wa_counters
5488c2ecf20Sopenharmony_ci					 *  [2]: L2P portion
5498c2ecf20Sopenharmony_ci					 *  [3]: vsc
5508c2ecf20Sopenharmony_ci					 */
5518c2ecf20Sopenharmony_ci	unsigned int emeta_sec[4];	/* Sectors needed for emeta. Same layout
5528c2ecf20Sopenharmony_ci					 * as emeta_len
5538c2ecf20Sopenharmony_ci					 */
5548c2ecf20Sopenharmony_ci
5558c2ecf20Sopenharmony_ci	unsigned int emeta_bb;		/* Boundary for bb that affects emeta */
5568c2ecf20Sopenharmony_ci
5578c2ecf20Sopenharmony_ci	unsigned int vsc_list_len;	/* Length for vsc list */
5588c2ecf20Sopenharmony_ci	unsigned int sec_bitmap_len;	/* Length for sector bitmap in line */
5598c2ecf20Sopenharmony_ci	unsigned int blk_bitmap_len;	/* Length for block bitmap in line */
5608c2ecf20Sopenharmony_ci	unsigned int lun_bitmap_len;	/* Length for lun bitmap in line */
5618c2ecf20Sopenharmony_ci
5628c2ecf20Sopenharmony_ci	unsigned int blk_per_line;	/* Number of blocks in a full line */
5638c2ecf20Sopenharmony_ci	unsigned int sec_per_line;	/* Number of sectors in a line */
5648c2ecf20Sopenharmony_ci	unsigned int dsec_per_line;	/* Number of data sectors in a line */
5658c2ecf20Sopenharmony_ci	unsigned int min_blk_line;	/* Min. number of good blocks in line */
5668c2ecf20Sopenharmony_ci
5678c2ecf20Sopenharmony_ci	unsigned int mid_thrs;		/* Threshold for GC mid list */
5688c2ecf20Sopenharmony_ci	unsigned int high_thrs;		/* Threshold for GC high list */
5698c2ecf20Sopenharmony_ci
5708c2ecf20Sopenharmony_ci	unsigned int meta_distance;	/* Distance between data and metadata */
5718c2ecf20Sopenharmony_ci};
5728c2ecf20Sopenharmony_ci
5738c2ecf20Sopenharmony_cienum {
5748c2ecf20Sopenharmony_ci	PBLK_STATE_RUNNING = 0,
5758c2ecf20Sopenharmony_ci	PBLK_STATE_STOPPING = 1,
5768c2ecf20Sopenharmony_ci	PBLK_STATE_RECOVERING = 2,
5778c2ecf20Sopenharmony_ci	PBLK_STATE_STOPPED = 3,
5788c2ecf20Sopenharmony_ci};
5798c2ecf20Sopenharmony_ci
5808c2ecf20Sopenharmony_ci/* Internal format to support not power-of-2 device formats */
5818c2ecf20Sopenharmony_cistruct pblk_addrf {
5828c2ecf20Sopenharmony_ci	/* gen to dev */
5838c2ecf20Sopenharmony_ci	int sec_stripe;
5848c2ecf20Sopenharmony_ci	int ch_stripe;
5858c2ecf20Sopenharmony_ci	int lun_stripe;
5868c2ecf20Sopenharmony_ci
5878c2ecf20Sopenharmony_ci	/* dev to gen */
5888c2ecf20Sopenharmony_ci	int sec_lun_stripe;
5898c2ecf20Sopenharmony_ci	int sec_ws_stripe;
5908c2ecf20Sopenharmony_ci};
5918c2ecf20Sopenharmony_ci
5928c2ecf20Sopenharmony_cistruct pblk {
5938c2ecf20Sopenharmony_ci	struct nvm_tgt_dev *dev;
5948c2ecf20Sopenharmony_ci	struct gendisk *disk;
5958c2ecf20Sopenharmony_ci
5968c2ecf20Sopenharmony_ci	struct kobject kobj;
5978c2ecf20Sopenharmony_ci
5988c2ecf20Sopenharmony_ci	struct pblk_lun *luns;
5998c2ecf20Sopenharmony_ci
6008c2ecf20Sopenharmony_ci	struct pblk_line *lines;		/* Line array */
6018c2ecf20Sopenharmony_ci	struct pblk_line_mgmt l_mg;		/* Line management */
6028c2ecf20Sopenharmony_ci	struct pblk_line_meta lm;		/* Line metadata */
6038c2ecf20Sopenharmony_ci
6048c2ecf20Sopenharmony_ci	struct nvm_addrf addrf;		/* Aligned address format */
6058c2ecf20Sopenharmony_ci	struct pblk_addrf uaddrf;	/* Unaligned address format */
6068c2ecf20Sopenharmony_ci	int addrf_len;
6078c2ecf20Sopenharmony_ci
6088c2ecf20Sopenharmony_ci	struct pblk_rb rwb;
6098c2ecf20Sopenharmony_ci
6108c2ecf20Sopenharmony_ci	int state;			/* pblk line state */
6118c2ecf20Sopenharmony_ci
6128c2ecf20Sopenharmony_ci	int min_write_pgs; /* Minimum amount of pages required by controller */
6138c2ecf20Sopenharmony_ci	int min_write_pgs_data; /* Minimum amount of payload pages */
6148c2ecf20Sopenharmony_ci	int max_write_pgs; /* Maximum amount of pages supported by controller */
6158c2ecf20Sopenharmony_ci	int oob_meta_size; /* Size of OOB sector metadata */
6168c2ecf20Sopenharmony_ci
6178c2ecf20Sopenharmony_ci	sector_t capacity; /* Device capacity when bad blocks are subtracted */
6188c2ecf20Sopenharmony_ci
6198c2ecf20Sopenharmony_ci	int op;      /* Percentage of device used for over-provisioning */
6208c2ecf20Sopenharmony_ci	int op_blks; /* Number of blocks used for over-provisioning */
6218c2ecf20Sopenharmony_ci
6228c2ecf20Sopenharmony_ci	/* pblk provisioning values. Used by rate limiter */
6238c2ecf20Sopenharmony_ci	struct pblk_rl rl;
6248c2ecf20Sopenharmony_ci
6258c2ecf20Sopenharmony_ci	int sec_per_write;
6268c2ecf20Sopenharmony_ci
6278c2ecf20Sopenharmony_ci	guid_t instance_uuid;
6288c2ecf20Sopenharmony_ci
6298c2ecf20Sopenharmony_ci	/* Persistent write amplification counters, 4kb sector I/Os */
6308c2ecf20Sopenharmony_ci	atomic64_t user_wa;		/* Sectors written by user */
6318c2ecf20Sopenharmony_ci	atomic64_t gc_wa;		/* Sectors written by GC */
6328c2ecf20Sopenharmony_ci	atomic64_t pad_wa;		/* Padded sectors written */
6338c2ecf20Sopenharmony_ci
6348c2ecf20Sopenharmony_ci	/* Reset values for delta write amplification measurements */
6358c2ecf20Sopenharmony_ci	u64 user_rst_wa;
6368c2ecf20Sopenharmony_ci	u64 gc_rst_wa;
6378c2ecf20Sopenharmony_ci	u64 pad_rst_wa;
6388c2ecf20Sopenharmony_ci
6398c2ecf20Sopenharmony_ci	/* Counters used for calculating padding distribution */
6408c2ecf20Sopenharmony_ci	atomic64_t *pad_dist;		/* Padding distribution buckets */
6418c2ecf20Sopenharmony_ci	u64 nr_flush_rst;		/* Flushes reset value for pad dist.*/
6428c2ecf20Sopenharmony_ci	atomic64_t nr_flush;		/* Number of flush/fua I/O */
6438c2ecf20Sopenharmony_ci
6448c2ecf20Sopenharmony_ci#ifdef CONFIG_NVM_PBLK_DEBUG
6458c2ecf20Sopenharmony_ci	/* Non-persistent debug counters, 4kb sector I/Os */
6468c2ecf20Sopenharmony_ci	atomic_long_t inflight_writes;	/* Inflight writes (user and gc) */
6478c2ecf20Sopenharmony_ci	atomic_long_t padded_writes;	/* Sectors padded due to flush/fua */
6488c2ecf20Sopenharmony_ci	atomic_long_t padded_wb;	/* Sectors padded in write buffer */
6498c2ecf20Sopenharmony_ci	atomic_long_t req_writes;	/* Sectors stored on write buffer */
6508c2ecf20Sopenharmony_ci	atomic_long_t sub_writes;	/* Sectors submitted from buffer */
6518c2ecf20Sopenharmony_ci	atomic_long_t sync_writes;	/* Sectors synced to media */
6528c2ecf20Sopenharmony_ci	atomic_long_t inflight_reads;	/* Inflight sector read requests */
6538c2ecf20Sopenharmony_ci	atomic_long_t cache_reads;	/* Read requests that hit the cache */
6548c2ecf20Sopenharmony_ci	atomic_long_t sync_reads;	/* Completed sector read requests */
6558c2ecf20Sopenharmony_ci	atomic_long_t recov_writes;	/* Sectors submitted from recovery */
6568c2ecf20Sopenharmony_ci	atomic_long_t recov_gc_writes;	/* Sectors submitted from write GC */
6578c2ecf20Sopenharmony_ci	atomic_long_t recov_gc_reads;	/* Sectors submitted from read GC */
6588c2ecf20Sopenharmony_ci#endif
6598c2ecf20Sopenharmony_ci
6608c2ecf20Sopenharmony_ci	spinlock_t lock;
6618c2ecf20Sopenharmony_ci
6628c2ecf20Sopenharmony_ci	atomic_long_t read_failed;
6638c2ecf20Sopenharmony_ci	atomic_long_t read_empty;
6648c2ecf20Sopenharmony_ci	atomic_long_t read_high_ecc;
6658c2ecf20Sopenharmony_ci	atomic_long_t read_failed_gc;
6668c2ecf20Sopenharmony_ci	atomic_long_t write_failed;
6678c2ecf20Sopenharmony_ci	atomic_long_t erase_failed;
6688c2ecf20Sopenharmony_ci
6698c2ecf20Sopenharmony_ci	atomic_t inflight_io;		/* General inflight I/O counter */
6708c2ecf20Sopenharmony_ci
6718c2ecf20Sopenharmony_ci	struct task_struct *writer_ts;
6728c2ecf20Sopenharmony_ci
6738c2ecf20Sopenharmony_ci	/* Simple translation map of logical addresses to physical addresses.
6748c2ecf20Sopenharmony_ci	 * The logical addresses is known by the host system, while the physical
6758c2ecf20Sopenharmony_ci	 * addresses are used when writing to the disk block device.
6768c2ecf20Sopenharmony_ci	 */
6778c2ecf20Sopenharmony_ci	unsigned char *trans_map;
6788c2ecf20Sopenharmony_ci	spinlock_t trans_lock;
6798c2ecf20Sopenharmony_ci
6808c2ecf20Sopenharmony_ci	struct list_head compl_list;
6818c2ecf20Sopenharmony_ci
6828c2ecf20Sopenharmony_ci	spinlock_t resubmit_lock;	 /* Resubmit list lock */
6838c2ecf20Sopenharmony_ci	struct list_head resubmit_list; /* Resubmit list for failed writes*/
6848c2ecf20Sopenharmony_ci
6858c2ecf20Sopenharmony_ci	mempool_t page_bio_pool;
6868c2ecf20Sopenharmony_ci	mempool_t gen_ws_pool;
6878c2ecf20Sopenharmony_ci	mempool_t rec_pool;
6888c2ecf20Sopenharmony_ci	mempool_t r_rq_pool;
6898c2ecf20Sopenharmony_ci	mempool_t w_rq_pool;
6908c2ecf20Sopenharmony_ci	mempool_t e_rq_pool;
6918c2ecf20Sopenharmony_ci
6928c2ecf20Sopenharmony_ci	struct workqueue_struct *close_wq;
6938c2ecf20Sopenharmony_ci	struct workqueue_struct *bb_wq;
6948c2ecf20Sopenharmony_ci	struct workqueue_struct *r_end_wq;
6958c2ecf20Sopenharmony_ci
6968c2ecf20Sopenharmony_ci	struct timer_list wtimer;
6978c2ecf20Sopenharmony_ci
6988c2ecf20Sopenharmony_ci	struct pblk_gc gc;
6998c2ecf20Sopenharmony_ci};
7008c2ecf20Sopenharmony_ci
7018c2ecf20Sopenharmony_cistruct pblk_line_ws {
7028c2ecf20Sopenharmony_ci	struct pblk *pblk;
7038c2ecf20Sopenharmony_ci	struct pblk_line *line;
7048c2ecf20Sopenharmony_ci	void *priv;
7058c2ecf20Sopenharmony_ci	struct work_struct ws;
7068c2ecf20Sopenharmony_ci};
7078c2ecf20Sopenharmony_ci
7088c2ecf20Sopenharmony_ci#define pblk_g_rq_size (sizeof(struct nvm_rq) + sizeof(struct pblk_g_ctx))
7098c2ecf20Sopenharmony_ci#define pblk_w_rq_size (sizeof(struct nvm_rq) + sizeof(struct pblk_c_ctx))
7108c2ecf20Sopenharmony_ci
7118c2ecf20Sopenharmony_ci#define pblk_err(pblk, fmt, ...)			\
7128c2ecf20Sopenharmony_ci	pr_err("pblk %s: " fmt, pblk->disk->disk_name, ##__VA_ARGS__)
7138c2ecf20Sopenharmony_ci#define pblk_info(pblk, fmt, ...)			\
7148c2ecf20Sopenharmony_ci	pr_info("pblk %s: " fmt, pblk->disk->disk_name, ##__VA_ARGS__)
7158c2ecf20Sopenharmony_ci#define pblk_warn(pblk, fmt, ...)			\
7168c2ecf20Sopenharmony_ci	pr_warn("pblk %s: " fmt, pblk->disk->disk_name, ##__VA_ARGS__)
7178c2ecf20Sopenharmony_ci#define pblk_debug(pblk, fmt, ...)			\
7188c2ecf20Sopenharmony_ci	pr_debug("pblk %s: " fmt, pblk->disk->disk_name, ##__VA_ARGS__)
7198c2ecf20Sopenharmony_ci
7208c2ecf20Sopenharmony_ci/*
7218c2ecf20Sopenharmony_ci * pblk ring buffer operations
7228c2ecf20Sopenharmony_ci */
7238c2ecf20Sopenharmony_ciint pblk_rb_init(struct pblk_rb *rb, unsigned int size, unsigned int threshold,
7248c2ecf20Sopenharmony_ci		 unsigned int seg_sz);
7258c2ecf20Sopenharmony_ciint pblk_rb_may_write_user(struct pblk_rb *rb, struct bio *bio,
7268c2ecf20Sopenharmony_ci			   unsigned int nr_entries, unsigned int *pos);
7278c2ecf20Sopenharmony_ciint pblk_rb_may_write_gc(struct pblk_rb *rb, unsigned int nr_entries,
7288c2ecf20Sopenharmony_ci			 unsigned int *pos);
7298c2ecf20Sopenharmony_civoid pblk_rb_write_entry_user(struct pblk_rb *rb, void *data,
7308c2ecf20Sopenharmony_ci			      struct pblk_w_ctx w_ctx, unsigned int pos);
7318c2ecf20Sopenharmony_civoid pblk_rb_write_entry_gc(struct pblk_rb *rb, void *data,
7328c2ecf20Sopenharmony_ci			    struct pblk_w_ctx w_ctx, struct pblk_line *line,
7338c2ecf20Sopenharmony_ci			    u64 paddr, unsigned int pos);
7348c2ecf20Sopenharmony_cistruct pblk_w_ctx *pblk_rb_w_ctx(struct pblk_rb *rb, unsigned int pos);
7358c2ecf20Sopenharmony_civoid pblk_rb_flush(struct pblk_rb *rb);
7368c2ecf20Sopenharmony_ci
7378c2ecf20Sopenharmony_civoid pblk_rb_sync_l2p(struct pblk_rb *rb);
7388c2ecf20Sopenharmony_ciunsigned int pblk_rb_read_to_bio(struct pblk_rb *rb, struct nvm_rq *rqd,
7398c2ecf20Sopenharmony_ci				 unsigned int pos, unsigned int nr_entries,
7408c2ecf20Sopenharmony_ci				 unsigned int count);
7418c2ecf20Sopenharmony_ciint pblk_rb_copy_to_bio(struct pblk_rb *rb, struct bio *bio, sector_t lba,
7428c2ecf20Sopenharmony_ci			struct ppa_addr ppa);
7438c2ecf20Sopenharmony_ciunsigned int pblk_rb_read_commit(struct pblk_rb *rb, unsigned int entries);
7448c2ecf20Sopenharmony_ci
7458c2ecf20Sopenharmony_ciunsigned int pblk_rb_sync_init(struct pblk_rb *rb, unsigned long *flags);
7468c2ecf20Sopenharmony_ciunsigned int pblk_rb_sync_advance(struct pblk_rb *rb, unsigned int nr_entries);
7478c2ecf20Sopenharmony_ciunsigned int pblk_rb_ptr_wrap(struct pblk_rb *rb, unsigned int p,
7488c2ecf20Sopenharmony_ci			      unsigned int nr_entries);
7498c2ecf20Sopenharmony_civoid pblk_rb_sync_end(struct pblk_rb *rb, unsigned long *flags);
7508c2ecf20Sopenharmony_ciunsigned int pblk_rb_flush_point_count(struct pblk_rb *rb);
7518c2ecf20Sopenharmony_ci
7528c2ecf20Sopenharmony_ciunsigned int pblk_rb_read_count(struct pblk_rb *rb);
7538c2ecf20Sopenharmony_ciunsigned int pblk_rb_sync_count(struct pblk_rb *rb);
7548c2ecf20Sopenharmony_ciunsigned int pblk_rb_wrap_pos(struct pblk_rb *rb, unsigned int pos);
7558c2ecf20Sopenharmony_ci
7568c2ecf20Sopenharmony_ciint pblk_rb_tear_down_check(struct pblk_rb *rb);
7578c2ecf20Sopenharmony_ciint pblk_rb_pos_oob(struct pblk_rb *rb, u64 pos);
7588c2ecf20Sopenharmony_civoid pblk_rb_free(struct pblk_rb *rb);
7598c2ecf20Sopenharmony_cissize_t pblk_rb_sysfs(struct pblk_rb *rb, char *buf);
7608c2ecf20Sopenharmony_ci
7618c2ecf20Sopenharmony_ci/*
7628c2ecf20Sopenharmony_ci * pblk core
7638c2ecf20Sopenharmony_ci */
7648c2ecf20Sopenharmony_cistruct nvm_rq *pblk_alloc_rqd(struct pblk *pblk, int type);
7658c2ecf20Sopenharmony_civoid pblk_free_rqd(struct pblk *pblk, struct nvm_rq *rqd, int type);
7668c2ecf20Sopenharmony_ciint pblk_alloc_rqd_meta(struct pblk *pblk, struct nvm_rq *rqd);
7678c2ecf20Sopenharmony_civoid pblk_free_rqd_meta(struct pblk *pblk, struct nvm_rq *rqd);
7688c2ecf20Sopenharmony_civoid pblk_set_sec_per_write(struct pblk *pblk, int sec_per_write);
7698c2ecf20Sopenharmony_ciint pblk_setup_w_rec_rq(struct pblk *pblk, struct nvm_rq *rqd,
7708c2ecf20Sopenharmony_ci			struct pblk_c_ctx *c_ctx);
7718c2ecf20Sopenharmony_civoid pblk_discard(struct pblk *pblk, struct bio *bio);
7728c2ecf20Sopenharmony_cistruct nvm_chk_meta *pblk_get_chunk_meta(struct pblk *pblk);
7738c2ecf20Sopenharmony_cistruct nvm_chk_meta *pblk_chunk_get_off(struct pblk *pblk,
7748c2ecf20Sopenharmony_ci					      struct nvm_chk_meta *lp,
7758c2ecf20Sopenharmony_ci					      struct ppa_addr ppa);
7768c2ecf20Sopenharmony_civoid pblk_log_write_err(struct pblk *pblk, struct nvm_rq *rqd);
7778c2ecf20Sopenharmony_civoid pblk_log_read_err(struct pblk *pblk, struct nvm_rq *rqd);
7788c2ecf20Sopenharmony_ciint pblk_submit_io(struct pblk *pblk, struct nvm_rq *rqd, void *buf);
7798c2ecf20Sopenharmony_ciint pblk_submit_io_sync(struct pblk *pblk, struct nvm_rq *rqd, void *buf);
7808c2ecf20Sopenharmony_ciint pblk_submit_meta_io(struct pblk *pblk, struct pblk_line *meta_line);
7818c2ecf20Sopenharmony_civoid pblk_check_chunk_state_update(struct pblk *pblk, struct nvm_rq *rqd);
7828c2ecf20Sopenharmony_cistruct pblk_line *pblk_line_get(struct pblk *pblk);
7838c2ecf20Sopenharmony_cistruct pblk_line *pblk_line_get_first_data(struct pblk *pblk);
7848c2ecf20Sopenharmony_cistruct pblk_line *pblk_line_replace_data(struct pblk *pblk);
7858c2ecf20Sopenharmony_civoid pblk_ppa_to_line_put(struct pblk *pblk, struct ppa_addr ppa);
7868c2ecf20Sopenharmony_civoid pblk_rq_to_line_put(struct pblk *pblk, struct nvm_rq *rqd);
7878c2ecf20Sopenharmony_ciint pblk_line_recov_alloc(struct pblk *pblk, struct pblk_line *line);
7888c2ecf20Sopenharmony_civoid pblk_line_recov_close(struct pblk *pblk, struct pblk_line *line);
7898c2ecf20Sopenharmony_cistruct pblk_line *pblk_line_get_data(struct pblk *pblk);
7908c2ecf20Sopenharmony_cistruct pblk_line *pblk_line_get_erase(struct pblk *pblk);
7918c2ecf20Sopenharmony_ciint pblk_line_erase(struct pblk *pblk, struct pblk_line *line);
7928c2ecf20Sopenharmony_ciint pblk_line_is_full(struct pblk_line *line);
7938c2ecf20Sopenharmony_civoid pblk_line_free(struct pblk_line *line);
7948c2ecf20Sopenharmony_civoid pblk_line_close_meta(struct pblk *pblk, struct pblk_line *line);
7958c2ecf20Sopenharmony_civoid pblk_line_close(struct pblk *pblk, struct pblk_line *line);
7968c2ecf20Sopenharmony_civoid pblk_line_close_ws(struct work_struct *work);
7978c2ecf20Sopenharmony_civoid pblk_pipeline_stop(struct pblk *pblk);
7988c2ecf20Sopenharmony_civoid __pblk_pipeline_stop(struct pblk *pblk);
7998c2ecf20Sopenharmony_civoid __pblk_pipeline_flush(struct pblk *pblk);
8008c2ecf20Sopenharmony_civoid pblk_gen_run_ws(struct pblk *pblk, struct pblk_line *line, void *priv,
8018c2ecf20Sopenharmony_ci		     void (*work)(struct work_struct *), gfp_t gfp_mask,
8028c2ecf20Sopenharmony_ci		     struct workqueue_struct *wq);
8038c2ecf20Sopenharmony_ciu64 pblk_line_smeta_start(struct pblk *pblk, struct pblk_line *line);
8048c2ecf20Sopenharmony_ciint pblk_line_smeta_read(struct pblk *pblk, struct pblk_line *line);
8058c2ecf20Sopenharmony_ciint pblk_line_emeta_read(struct pblk *pblk, struct pblk_line *line,
8068c2ecf20Sopenharmony_ci			 void *emeta_buf);
8078c2ecf20Sopenharmony_ciint pblk_blk_erase_async(struct pblk *pblk, struct ppa_addr erase_ppa);
8088c2ecf20Sopenharmony_civoid pblk_line_put(struct kref *ref);
8098c2ecf20Sopenharmony_civoid pblk_line_put_wq(struct kref *ref);
8108c2ecf20Sopenharmony_cistruct list_head *pblk_line_gc_list(struct pblk *pblk, struct pblk_line *line);
8118c2ecf20Sopenharmony_ciu64 pblk_lookup_page(struct pblk *pblk, struct pblk_line *line);
8128c2ecf20Sopenharmony_civoid pblk_dealloc_page(struct pblk *pblk, struct pblk_line *line, int nr_secs);
8138c2ecf20Sopenharmony_ciu64 pblk_alloc_page(struct pblk *pblk, struct pblk_line *line, int nr_secs);
8148c2ecf20Sopenharmony_ciu64 __pblk_alloc_page(struct pblk *pblk, struct pblk_line *line, int nr_secs);
8158c2ecf20Sopenharmony_ciint pblk_calc_secs(struct pblk *pblk, unsigned long secs_avail,
8168c2ecf20Sopenharmony_ci		   unsigned long secs_to_flush, bool skip_meta);
8178c2ecf20Sopenharmony_civoid pblk_down_rq(struct pblk *pblk, struct ppa_addr ppa,
8188c2ecf20Sopenharmony_ci		  unsigned long *lun_bitmap);
8198c2ecf20Sopenharmony_civoid pblk_down_chunk(struct pblk *pblk, struct ppa_addr ppa);
8208c2ecf20Sopenharmony_civoid pblk_up_chunk(struct pblk *pblk, struct ppa_addr ppa);
8218c2ecf20Sopenharmony_civoid pblk_up_rq(struct pblk *pblk, unsigned long *lun_bitmap);
8228c2ecf20Sopenharmony_ciint pblk_bio_add_pages(struct pblk *pblk, struct bio *bio, gfp_t flags,
8238c2ecf20Sopenharmony_ci		       int nr_pages);
8248c2ecf20Sopenharmony_civoid pblk_bio_free_pages(struct pblk *pblk, struct bio *bio, int off,
8258c2ecf20Sopenharmony_ci			 int nr_pages);
8268c2ecf20Sopenharmony_civoid pblk_map_invalidate(struct pblk *pblk, struct ppa_addr ppa);
8278c2ecf20Sopenharmony_civoid __pblk_map_invalidate(struct pblk *pblk, struct pblk_line *line,
8288c2ecf20Sopenharmony_ci			   u64 paddr);
8298c2ecf20Sopenharmony_civoid pblk_update_map(struct pblk *pblk, sector_t lba, struct ppa_addr ppa);
8308c2ecf20Sopenharmony_civoid pblk_update_map_cache(struct pblk *pblk, sector_t lba,
8318c2ecf20Sopenharmony_ci			   struct ppa_addr ppa);
8328c2ecf20Sopenharmony_civoid pblk_update_map_dev(struct pblk *pblk, sector_t lba,
8338c2ecf20Sopenharmony_ci			 struct ppa_addr ppa, struct ppa_addr entry_line);
8348c2ecf20Sopenharmony_ciint pblk_update_map_gc(struct pblk *pblk, sector_t lba, struct ppa_addr ppa,
8358c2ecf20Sopenharmony_ci		       struct pblk_line *gc_line, u64 paddr);
8368c2ecf20Sopenharmony_civoid pblk_lookup_l2p_rand(struct pblk *pblk, struct ppa_addr *ppas,
8378c2ecf20Sopenharmony_ci			  u64 *lba_list, int nr_secs);
8388c2ecf20Sopenharmony_ciint pblk_lookup_l2p_seq(struct pblk *pblk, struct ppa_addr *ppas,
8398c2ecf20Sopenharmony_ci			 sector_t blba, int nr_secs, bool *from_cache);
8408c2ecf20Sopenharmony_civoid *pblk_get_meta_for_writes(struct pblk *pblk, struct nvm_rq *rqd);
8418c2ecf20Sopenharmony_civoid pblk_get_packed_meta(struct pblk *pblk, struct nvm_rq *rqd);
8428c2ecf20Sopenharmony_ci
8438c2ecf20Sopenharmony_ci/*
8448c2ecf20Sopenharmony_ci * pblk user I/O write path
8458c2ecf20Sopenharmony_ci */
8468c2ecf20Sopenharmony_civoid pblk_write_to_cache(struct pblk *pblk, struct bio *bio,
8478c2ecf20Sopenharmony_ci			unsigned long flags);
8488c2ecf20Sopenharmony_ciint pblk_write_gc_to_cache(struct pblk *pblk, struct pblk_gc_rq *gc_rq);
8498c2ecf20Sopenharmony_ci
8508c2ecf20Sopenharmony_ci/*
8518c2ecf20Sopenharmony_ci * pblk map
8528c2ecf20Sopenharmony_ci */
8538c2ecf20Sopenharmony_ciint pblk_map_erase_rq(struct pblk *pblk, struct nvm_rq *rqd,
8548c2ecf20Sopenharmony_ci		       unsigned int sentry, unsigned long *lun_bitmap,
8558c2ecf20Sopenharmony_ci		       unsigned int valid_secs, struct ppa_addr *erase_ppa);
8568c2ecf20Sopenharmony_ciint pblk_map_rq(struct pblk *pblk, struct nvm_rq *rqd, unsigned int sentry,
8578c2ecf20Sopenharmony_ci		 unsigned long *lun_bitmap, unsigned int valid_secs,
8588c2ecf20Sopenharmony_ci		 unsigned int off);
8598c2ecf20Sopenharmony_ci
8608c2ecf20Sopenharmony_ci/*
8618c2ecf20Sopenharmony_ci * pblk write thread
8628c2ecf20Sopenharmony_ci */
8638c2ecf20Sopenharmony_ciint pblk_write_ts(void *data);
8648c2ecf20Sopenharmony_civoid pblk_write_timer_fn(struct timer_list *t);
8658c2ecf20Sopenharmony_civoid pblk_write_should_kick(struct pblk *pblk);
8668c2ecf20Sopenharmony_civoid pblk_write_kick(struct pblk *pblk);
8678c2ecf20Sopenharmony_ci
8688c2ecf20Sopenharmony_ci/*
8698c2ecf20Sopenharmony_ci * pblk read path
8708c2ecf20Sopenharmony_ci */
8718c2ecf20Sopenharmony_ciextern struct bio_set pblk_bio_set;
8728c2ecf20Sopenharmony_civoid pblk_submit_read(struct pblk *pblk, struct bio *bio);
8738c2ecf20Sopenharmony_ciint pblk_submit_read_gc(struct pblk *pblk, struct pblk_gc_rq *gc_rq);
8748c2ecf20Sopenharmony_ci/*
8758c2ecf20Sopenharmony_ci * pblk recovery
8768c2ecf20Sopenharmony_ci */
8778c2ecf20Sopenharmony_cistruct pblk_line *pblk_recov_l2p(struct pblk *pblk);
8788c2ecf20Sopenharmony_ciint pblk_recov_pad(struct pblk *pblk);
8798c2ecf20Sopenharmony_ciint pblk_recov_check_emeta(struct pblk *pblk, struct line_emeta *emeta);
8808c2ecf20Sopenharmony_ci
8818c2ecf20Sopenharmony_ci/*
8828c2ecf20Sopenharmony_ci * pblk gc
8838c2ecf20Sopenharmony_ci */
8848c2ecf20Sopenharmony_ci#define PBLK_GC_MAX_READERS 8	/* Max number of outstanding GC reader jobs */
8858c2ecf20Sopenharmony_ci#define PBLK_GC_RQ_QD 128	/* Queue depth for inflight GC requests */
8868c2ecf20Sopenharmony_ci#define PBLK_GC_L_QD 4		/* Queue depth for inflight GC lines */
8878c2ecf20Sopenharmony_ci
8888c2ecf20Sopenharmony_ciint pblk_gc_init(struct pblk *pblk);
8898c2ecf20Sopenharmony_civoid pblk_gc_exit(struct pblk *pblk, bool graceful);
8908c2ecf20Sopenharmony_civoid pblk_gc_should_start(struct pblk *pblk);
8918c2ecf20Sopenharmony_civoid pblk_gc_should_stop(struct pblk *pblk);
8928c2ecf20Sopenharmony_civoid pblk_gc_should_kick(struct pblk *pblk);
8938c2ecf20Sopenharmony_civoid pblk_gc_free_full_lines(struct pblk *pblk);
8948c2ecf20Sopenharmony_civoid pblk_gc_sysfs_state_show(struct pblk *pblk, int *gc_enabled,
8958c2ecf20Sopenharmony_ci			      int *gc_active);
8968c2ecf20Sopenharmony_ciint pblk_gc_sysfs_force(struct pblk *pblk, int force);
8978c2ecf20Sopenharmony_civoid pblk_put_line_back(struct pblk *pblk, struct pblk_line *line);
8988c2ecf20Sopenharmony_ci
8998c2ecf20Sopenharmony_ci/*
9008c2ecf20Sopenharmony_ci * pblk rate limiter
9018c2ecf20Sopenharmony_ci */
9028c2ecf20Sopenharmony_civoid pblk_rl_init(struct pblk_rl *rl, int budget, int threshold);
9038c2ecf20Sopenharmony_civoid pblk_rl_free(struct pblk_rl *rl);
9048c2ecf20Sopenharmony_civoid pblk_rl_update_rates(struct pblk_rl *rl);
9058c2ecf20Sopenharmony_ciint pblk_rl_high_thrs(struct pblk_rl *rl);
9068c2ecf20Sopenharmony_ciunsigned long pblk_rl_nr_free_blks(struct pblk_rl *rl);
9078c2ecf20Sopenharmony_ciunsigned long pblk_rl_nr_user_free_blks(struct pblk_rl *rl);
9088c2ecf20Sopenharmony_ciint pblk_rl_user_may_insert(struct pblk_rl *rl, int nr_entries);
9098c2ecf20Sopenharmony_civoid pblk_rl_inserted(struct pblk_rl *rl, int nr_entries);
9108c2ecf20Sopenharmony_civoid pblk_rl_user_in(struct pblk_rl *rl, int nr_entries);
9118c2ecf20Sopenharmony_ciint pblk_rl_gc_may_insert(struct pblk_rl *rl, int nr_entries);
9128c2ecf20Sopenharmony_civoid pblk_rl_gc_in(struct pblk_rl *rl, int nr_entries);
9138c2ecf20Sopenharmony_civoid pblk_rl_out(struct pblk_rl *rl, int nr_user, int nr_gc);
9148c2ecf20Sopenharmony_ciint pblk_rl_max_io(struct pblk_rl *rl);
9158c2ecf20Sopenharmony_civoid pblk_rl_free_lines_inc(struct pblk_rl *rl, struct pblk_line *line);
9168c2ecf20Sopenharmony_civoid pblk_rl_free_lines_dec(struct pblk_rl *rl, struct pblk_line *line,
9178c2ecf20Sopenharmony_ci			    bool used);
9188c2ecf20Sopenharmony_ciint pblk_rl_is_limit(struct pblk_rl *rl);
9198c2ecf20Sopenharmony_ci
9208c2ecf20Sopenharmony_civoid pblk_rl_werr_line_in(struct pblk_rl *rl);
9218c2ecf20Sopenharmony_civoid pblk_rl_werr_line_out(struct pblk_rl *rl);
9228c2ecf20Sopenharmony_ci
9238c2ecf20Sopenharmony_ci/*
9248c2ecf20Sopenharmony_ci * pblk sysfs
9258c2ecf20Sopenharmony_ci */
9268c2ecf20Sopenharmony_ciint pblk_sysfs_init(struct gendisk *tdisk);
9278c2ecf20Sopenharmony_civoid pblk_sysfs_exit(struct gendisk *tdisk);
9288c2ecf20Sopenharmony_ci
9298c2ecf20Sopenharmony_cistatic inline struct nvm_rq *nvm_rq_from_c_ctx(void *c_ctx)
9308c2ecf20Sopenharmony_ci{
9318c2ecf20Sopenharmony_ci	return c_ctx - sizeof(struct nvm_rq);
9328c2ecf20Sopenharmony_ci}
9338c2ecf20Sopenharmony_ci
9348c2ecf20Sopenharmony_cistatic inline void *emeta_to_bb(struct line_emeta *emeta)
9358c2ecf20Sopenharmony_ci{
9368c2ecf20Sopenharmony_ci	return emeta->bb_bitmap;
9378c2ecf20Sopenharmony_ci}
9388c2ecf20Sopenharmony_ci
9398c2ecf20Sopenharmony_cistatic inline void *emeta_to_wa(struct pblk_line_meta *lm,
9408c2ecf20Sopenharmony_ci				struct line_emeta *emeta)
9418c2ecf20Sopenharmony_ci{
9428c2ecf20Sopenharmony_ci	return emeta->bb_bitmap + lm->blk_bitmap_len;
9438c2ecf20Sopenharmony_ci}
9448c2ecf20Sopenharmony_ci
9458c2ecf20Sopenharmony_cistatic inline void *emeta_to_lbas(struct pblk *pblk, struct line_emeta *emeta)
9468c2ecf20Sopenharmony_ci{
9478c2ecf20Sopenharmony_ci	return ((void *)emeta + pblk->lm.emeta_len[1]);
9488c2ecf20Sopenharmony_ci}
9498c2ecf20Sopenharmony_ci
9508c2ecf20Sopenharmony_cistatic inline void *emeta_to_vsc(struct pblk *pblk, struct line_emeta *emeta)
9518c2ecf20Sopenharmony_ci{
9528c2ecf20Sopenharmony_ci	return (emeta_to_lbas(pblk, emeta) + pblk->lm.emeta_len[2]);
9538c2ecf20Sopenharmony_ci}
9548c2ecf20Sopenharmony_ci
9558c2ecf20Sopenharmony_cistatic inline int pblk_line_vsc(struct pblk_line *line)
9568c2ecf20Sopenharmony_ci{
9578c2ecf20Sopenharmony_ci	return le32_to_cpu(*line->vsc);
9588c2ecf20Sopenharmony_ci}
9598c2ecf20Sopenharmony_ci
9608c2ecf20Sopenharmony_cistatic inline int pblk_ppa_to_line_id(struct ppa_addr p)
9618c2ecf20Sopenharmony_ci{
9628c2ecf20Sopenharmony_ci	return p.a.blk;
9638c2ecf20Sopenharmony_ci}
9648c2ecf20Sopenharmony_ci
9658c2ecf20Sopenharmony_cistatic inline struct pblk_line *pblk_ppa_to_line(struct pblk *pblk,
9668c2ecf20Sopenharmony_ci						 struct ppa_addr p)
9678c2ecf20Sopenharmony_ci{
9688c2ecf20Sopenharmony_ci	return &pblk->lines[pblk_ppa_to_line_id(p)];
9698c2ecf20Sopenharmony_ci}
9708c2ecf20Sopenharmony_ci
9718c2ecf20Sopenharmony_cistatic inline int pblk_ppa_to_pos(struct nvm_geo *geo, struct ppa_addr p)
9728c2ecf20Sopenharmony_ci{
9738c2ecf20Sopenharmony_ci	return p.a.lun * geo->num_ch + p.a.ch;
9748c2ecf20Sopenharmony_ci}
9758c2ecf20Sopenharmony_ci
9768c2ecf20Sopenharmony_cistatic inline struct ppa_addr addr_to_gen_ppa(struct pblk *pblk, u64 paddr,
9778c2ecf20Sopenharmony_ci					      u64 line_id)
9788c2ecf20Sopenharmony_ci{
9798c2ecf20Sopenharmony_ci	struct nvm_tgt_dev *dev = pblk->dev;
9808c2ecf20Sopenharmony_ci	struct nvm_geo *geo = &dev->geo;
9818c2ecf20Sopenharmony_ci	struct ppa_addr ppa;
9828c2ecf20Sopenharmony_ci
9838c2ecf20Sopenharmony_ci	if (geo->version == NVM_OCSSD_SPEC_12) {
9848c2ecf20Sopenharmony_ci		struct nvm_addrf_12 *ppaf = (struct nvm_addrf_12 *)&pblk->addrf;
9858c2ecf20Sopenharmony_ci
9868c2ecf20Sopenharmony_ci		ppa.ppa = 0;
9878c2ecf20Sopenharmony_ci		ppa.g.blk = line_id;
9888c2ecf20Sopenharmony_ci		ppa.g.pg = (paddr & ppaf->pg_mask) >> ppaf->pg_offset;
9898c2ecf20Sopenharmony_ci		ppa.g.lun = (paddr & ppaf->lun_mask) >> ppaf->lun_offset;
9908c2ecf20Sopenharmony_ci		ppa.g.ch = (paddr & ppaf->ch_mask) >> ppaf->ch_offset;
9918c2ecf20Sopenharmony_ci		ppa.g.pl = (paddr & ppaf->pln_mask) >> ppaf->pln_offset;
9928c2ecf20Sopenharmony_ci		ppa.g.sec = (paddr & ppaf->sec_mask) >> ppaf->sec_offset;
9938c2ecf20Sopenharmony_ci	} else {
9948c2ecf20Sopenharmony_ci		struct pblk_addrf *uaddrf = &pblk->uaddrf;
9958c2ecf20Sopenharmony_ci		int secs, chnls, luns;
9968c2ecf20Sopenharmony_ci
9978c2ecf20Sopenharmony_ci		ppa.ppa = 0;
9988c2ecf20Sopenharmony_ci
9998c2ecf20Sopenharmony_ci		ppa.m.chk = line_id;
10008c2ecf20Sopenharmony_ci
10018c2ecf20Sopenharmony_ci		paddr = div_u64_rem(paddr, uaddrf->sec_stripe, &secs);
10028c2ecf20Sopenharmony_ci		ppa.m.sec = secs;
10038c2ecf20Sopenharmony_ci
10048c2ecf20Sopenharmony_ci		paddr = div_u64_rem(paddr, uaddrf->ch_stripe, &chnls);
10058c2ecf20Sopenharmony_ci		ppa.m.grp = chnls;
10068c2ecf20Sopenharmony_ci
10078c2ecf20Sopenharmony_ci		paddr = div_u64_rem(paddr, uaddrf->lun_stripe, &luns);
10088c2ecf20Sopenharmony_ci		ppa.m.pu = luns;
10098c2ecf20Sopenharmony_ci
10108c2ecf20Sopenharmony_ci		ppa.m.sec += uaddrf->sec_stripe * paddr;
10118c2ecf20Sopenharmony_ci	}
10128c2ecf20Sopenharmony_ci
10138c2ecf20Sopenharmony_ci	return ppa;
10148c2ecf20Sopenharmony_ci}
10158c2ecf20Sopenharmony_ci
10168c2ecf20Sopenharmony_cistatic inline struct nvm_chk_meta *pblk_dev_ppa_to_chunk(struct pblk *pblk,
10178c2ecf20Sopenharmony_ci							struct ppa_addr p)
10188c2ecf20Sopenharmony_ci{
10198c2ecf20Sopenharmony_ci	struct nvm_tgt_dev *dev = pblk->dev;
10208c2ecf20Sopenharmony_ci	struct nvm_geo *geo = &dev->geo;
10218c2ecf20Sopenharmony_ci	struct pblk_line *line = pblk_ppa_to_line(pblk, p);
10228c2ecf20Sopenharmony_ci	int pos = pblk_ppa_to_pos(geo, p);
10238c2ecf20Sopenharmony_ci
10248c2ecf20Sopenharmony_ci	return &line->chks[pos];
10258c2ecf20Sopenharmony_ci}
10268c2ecf20Sopenharmony_ci
10278c2ecf20Sopenharmony_cistatic inline u64 pblk_dev_ppa_to_chunk_addr(struct pblk *pblk,
10288c2ecf20Sopenharmony_ci							struct ppa_addr p)
10298c2ecf20Sopenharmony_ci{
10308c2ecf20Sopenharmony_ci	struct nvm_tgt_dev *dev = pblk->dev;
10318c2ecf20Sopenharmony_ci
10328c2ecf20Sopenharmony_ci	return dev_to_chunk_addr(dev->parent, &pblk->addrf, p);
10338c2ecf20Sopenharmony_ci}
10348c2ecf20Sopenharmony_ci
10358c2ecf20Sopenharmony_cistatic inline u64 pblk_dev_ppa_to_line_addr(struct pblk *pblk,
10368c2ecf20Sopenharmony_ci							struct ppa_addr p)
10378c2ecf20Sopenharmony_ci{
10388c2ecf20Sopenharmony_ci	struct nvm_tgt_dev *dev = pblk->dev;
10398c2ecf20Sopenharmony_ci	struct nvm_geo *geo = &dev->geo;
10408c2ecf20Sopenharmony_ci	u64 paddr;
10418c2ecf20Sopenharmony_ci
10428c2ecf20Sopenharmony_ci	if (geo->version == NVM_OCSSD_SPEC_12) {
10438c2ecf20Sopenharmony_ci		struct nvm_addrf_12 *ppaf = (struct nvm_addrf_12 *)&pblk->addrf;
10448c2ecf20Sopenharmony_ci
10458c2ecf20Sopenharmony_ci		paddr = (u64)p.g.ch << ppaf->ch_offset;
10468c2ecf20Sopenharmony_ci		paddr |= (u64)p.g.lun << ppaf->lun_offset;
10478c2ecf20Sopenharmony_ci		paddr |= (u64)p.g.pg << ppaf->pg_offset;
10488c2ecf20Sopenharmony_ci		paddr |= (u64)p.g.pl << ppaf->pln_offset;
10498c2ecf20Sopenharmony_ci		paddr |= (u64)p.g.sec << ppaf->sec_offset;
10508c2ecf20Sopenharmony_ci	} else {
10518c2ecf20Sopenharmony_ci		struct pblk_addrf *uaddrf = &pblk->uaddrf;
10528c2ecf20Sopenharmony_ci		u64 secs = p.m.sec;
10538c2ecf20Sopenharmony_ci		int sec_stripe;
10548c2ecf20Sopenharmony_ci
10558c2ecf20Sopenharmony_ci		paddr = (u64)p.m.grp * uaddrf->sec_stripe;
10568c2ecf20Sopenharmony_ci		paddr += (u64)p.m.pu * uaddrf->sec_lun_stripe;
10578c2ecf20Sopenharmony_ci
10588c2ecf20Sopenharmony_ci		secs = div_u64_rem(secs, uaddrf->sec_stripe, &sec_stripe);
10598c2ecf20Sopenharmony_ci		paddr += secs * uaddrf->sec_ws_stripe;
10608c2ecf20Sopenharmony_ci		paddr += sec_stripe;
10618c2ecf20Sopenharmony_ci	}
10628c2ecf20Sopenharmony_ci
10638c2ecf20Sopenharmony_ci	return paddr;
10648c2ecf20Sopenharmony_ci}
10658c2ecf20Sopenharmony_ci
10668c2ecf20Sopenharmony_cistatic inline struct ppa_addr pblk_ppa32_to_ppa64(struct pblk *pblk, u32 ppa32)
10678c2ecf20Sopenharmony_ci{
10688c2ecf20Sopenharmony_ci	struct nvm_tgt_dev *dev = pblk->dev;
10698c2ecf20Sopenharmony_ci
10708c2ecf20Sopenharmony_ci	return nvm_ppa32_to_ppa64(dev->parent, &pblk->addrf, ppa32);
10718c2ecf20Sopenharmony_ci}
10728c2ecf20Sopenharmony_ci
10738c2ecf20Sopenharmony_cistatic inline u32 pblk_ppa64_to_ppa32(struct pblk *pblk, struct ppa_addr ppa64)
10748c2ecf20Sopenharmony_ci{
10758c2ecf20Sopenharmony_ci	struct nvm_tgt_dev *dev = pblk->dev;
10768c2ecf20Sopenharmony_ci
10778c2ecf20Sopenharmony_ci	return nvm_ppa64_to_ppa32(dev->parent, &pblk->addrf, ppa64);
10788c2ecf20Sopenharmony_ci}
10798c2ecf20Sopenharmony_ci
10808c2ecf20Sopenharmony_cistatic inline struct ppa_addr pblk_trans_map_get(struct pblk *pblk,
10818c2ecf20Sopenharmony_ci								sector_t lba)
10828c2ecf20Sopenharmony_ci{
10838c2ecf20Sopenharmony_ci	struct ppa_addr ppa;
10848c2ecf20Sopenharmony_ci
10858c2ecf20Sopenharmony_ci	if (pblk->addrf_len < 32) {
10868c2ecf20Sopenharmony_ci		u32 *map = (u32 *)pblk->trans_map;
10878c2ecf20Sopenharmony_ci
10888c2ecf20Sopenharmony_ci		ppa = pblk_ppa32_to_ppa64(pblk, map[lba]);
10898c2ecf20Sopenharmony_ci	} else {
10908c2ecf20Sopenharmony_ci		struct ppa_addr *map = (struct ppa_addr *)pblk->trans_map;
10918c2ecf20Sopenharmony_ci
10928c2ecf20Sopenharmony_ci		ppa = map[lba];
10938c2ecf20Sopenharmony_ci	}
10948c2ecf20Sopenharmony_ci
10958c2ecf20Sopenharmony_ci	return ppa;
10968c2ecf20Sopenharmony_ci}
10978c2ecf20Sopenharmony_ci
10988c2ecf20Sopenharmony_cistatic inline void pblk_trans_map_set(struct pblk *pblk, sector_t lba,
10998c2ecf20Sopenharmony_ci						struct ppa_addr ppa)
11008c2ecf20Sopenharmony_ci{
11018c2ecf20Sopenharmony_ci	if (pblk->addrf_len < 32) {
11028c2ecf20Sopenharmony_ci		u32 *map = (u32 *)pblk->trans_map;
11038c2ecf20Sopenharmony_ci
11048c2ecf20Sopenharmony_ci		map[lba] = pblk_ppa64_to_ppa32(pblk, ppa);
11058c2ecf20Sopenharmony_ci	} else {
11068c2ecf20Sopenharmony_ci		u64 *map = (u64 *)pblk->trans_map;
11078c2ecf20Sopenharmony_ci
11088c2ecf20Sopenharmony_ci		map[lba] = ppa.ppa;
11098c2ecf20Sopenharmony_ci	}
11108c2ecf20Sopenharmony_ci}
11118c2ecf20Sopenharmony_ci
11128c2ecf20Sopenharmony_cistatic inline int pblk_ppa_empty(struct ppa_addr ppa_addr)
11138c2ecf20Sopenharmony_ci{
11148c2ecf20Sopenharmony_ci	return (ppa_addr.ppa == ADDR_EMPTY);
11158c2ecf20Sopenharmony_ci}
11168c2ecf20Sopenharmony_ci
11178c2ecf20Sopenharmony_cistatic inline void pblk_ppa_set_empty(struct ppa_addr *ppa_addr)
11188c2ecf20Sopenharmony_ci{
11198c2ecf20Sopenharmony_ci	ppa_addr->ppa = ADDR_EMPTY;
11208c2ecf20Sopenharmony_ci}
11218c2ecf20Sopenharmony_ci
11228c2ecf20Sopenharmony_cistatic inline bool pblk_ppa_comp(struct ppa_addr lppa, struct ppa_addr rppa)
11238c2ecf20Sopenharmony_ci{
11248c2ecf20Sopenharmony_ci	return (lppa.ppa == rppa.ppa);
11258c2ecf20Sopenharmony_ci}
11268c2ecf20Sopenharmony_ci
11278c2ecf20Sopenharmony_cistatic inline int pblk_addr_in_cache(struct ppa_addr ppa)
11288c2ecf20Sopenharmony_ci{
11298c2ecf20Sopenharmony_ci	return (ppa.ppa != ADDR_EMPTY && ppa.c.is_cached);
11308c2ecf20Sopenharmony_ci}
11318c2ecf20Sopenharmony_ci
11328c2ecf20Sopenharmony_cistatic inline int pblk_addr_to_cacheline(struct ppa_addr ppa)
11338c2ecf20Sopenharmony_ci{
11348c2ecf20Sopenharmony_ci	return ppa.c.line;
11358c2ecf20Sopenharmony_ci}
11368c2ecf20Sopenharmony_ci
11378c2ecf20Sopenharmony_cistatic inline struct ppa_addr pblk_cacheline_to_addr(int addr)
11388c2ecf20Sopenharmony_ci{
11398c2ecf20Sopenharmony_ci	struct ppa_addr p;
11408c2ecf20Sopenharmony_ci
11418c2ecf20Sopenharmony_ci	p.c.line = addr;
11428c2ecf20Sopenharmony_ci	p.c.is_cached = 1;
11438c2ecf20Sopenharmony_ci
11448c2ecf20Sopenharmony_ci	return p;
11458c2ecf20Sopenharmony_ci}
11468c2ecf20Sopenharmony_ci
11478c2ecf20Sopenharmony_cistatic inline u32 pblk_calc_meta_header_crc(struct pblk *pblk,
11488c2ecf20Sopenharmony_ci					    struct line_header *header)
11498c2ecf20Sopenharmony_ci{
11508c2ecf20Sopenharmony_ci	u32 crc = ~(u32)0;
11518c2ecf20Sopenharmony_ci
11528c2ecf20Sopenharmony_ci	crc = crc32_le(crc, (unsigned char *)header + sizeof(crc),
11538c2ecf20Sopenharmony_ci				sizeof(struct line_header) - sizeof(crc));
11548c2ecf20Sopenharmony_ci
11558c2ecf20Sopenharmony_ci	return crc;
11568c2ecf20Sopenharmony_ci}
11578c2ecf20Sopenharmony_ci
11588c2ecf20Sopenharmony_cistatic inline u32 pblk_calc_smeta_crc(struct pblk *pblk,
11598c2ecf20Sopenharmony_ci				      struct line_smeta *smeta)
11608c2ecf20Sopenharmony_ci{
11618c2ecf20Sopenharmony_ci	struct pblk_line_meta *lm = &pblk->lm;
11628c2ecf20Sopenharmony_ci	u32 crc = ~(u32)0;
11638c2ecf20Sopenharmony_ci
11648c2ecf20Sopenharmony_ci	crc = crc32_le(crc, (unsigned char *)smeta +
11658c2ecf20Sopenharmony_ci				sizeof(struct line_header) + sizeof(crc),
11668c2ecf20Sopenharmony_ci				lm->smeta_len -
11678c2ecf20Sopenharmony_ci				sizeof(struct line_header) - sizeof(crc));
11688c2ecf20Sopenharmony_ci
11698c2ecf20Sopenharmony_ci	return crc;
11708c2ecf20Sopenharmony_ci}
11718c2ecf20Sopenharmony_ci
11728c2ecf20Sopenharmony_cistatic inline u32 pblk_calc_emeta_crc(struct pblk *pblk,
11738c2ecf20Sopenharmony_ci				      struct line_emeta *emeta)
11748c2ecf20Sopenharmony_ci{
11758c2ecf20Sopenharmony_ci	struct pblk_line_meta *lm = &pblk->lm;
11768c2ecf20Sopenharmony_ci	u32 crc = ~(u32)0;
11778c2ecf20Sopenharmony_ci
11788c2ecf20Sopenharmony_ci	crc = crc32_le(crc, (unsigned char *)emeta +
11798c2ecf20Sopenharmony_ci				sizeof(struct line_header) + sizeof(crc),
11808c2ecf20Sopenharmony_ci				lm->emeta_len[0] -
11818c2ecf20Sopenharmony_ci				sizeof(struct line_header) - sizeof(crc));
11828c2ecf20Sopenharmony_ci
11838c2ecf20Sopenharmony_ci	return crc;
11848c2ecf20Sopenharmony_ci}
11858c2ecf20Sopenharmony_ci
11868c2ecf20Sopenharmony_cistatic inline int pblk_io_aligned(struct pblk *pblk, int nr_secs)
11878c2ecf20Sopenharmony_ci{
11888c2ecf20Sopenharmony_ci	return !(nr_secs % pblk->min_write_pgs);
11898c2ecf20Sopenharmony_ci}
11908c2ecf20Sopenharmony_ci
11918c2ecf20Sopenharmony_ci#ifdef CONFIG_NVM_PBLK_DEBUG
11928c2ecf20Sopenharmony_cistatic inline void print_ppa(struct pblk *pblk, struct ppa_addr *p,
11938c2ecf20Sopenharmony_ci			     char *msg, int error)
11948c2ecf20Sopenharmony_ci{
11958c2ecf20Sopenharmony_ci	struct nvm_geo *geo = &pblk->dev->geo;
11968c2ecf20Sopenharmony_ci
11978c2ecf20Sopenharmony_ci	if (p->c.is_cached) {
11988c2ecf20Sopenharmony_ci		pblk_err(pblk, "ppa: (%s: %x) cache line: %llu\n",
11998c2ecf20Sopenharmony_ci				msg, error, (u64)p->c.line);
12008c2ecf20Sopenharmony_ci	} else if (geo->version == NVM_OCSSD_SPEC_12) {
12018c2ecf20Sopenharmony_ci		pblk_err(pblk, "ppa: (%s: %x):ch:%d,lun:%d,blk:%d,pg:%d,pl:%d,sec:%d\n",
12028c2ecf20Sopenharmony_ci			msg, error,
12038c2ecf20Sopenharmony_ci			p->g.ch, p->g.lun, p->g.blk,
12048c2ecf20Sopenharmony_ci			p->g.pg, p->g.pl, p->g.sec);
12058c2ecf20Sopenharmony_ci	} else {
12068c2ecf20Sopenharmony_ci		pblk_err(pblk, "ppa: (%s: %x):ch:%d,lun:%d,chk:%d,sec:%d\n",
12078c2ecf20Sopenharmony_ci			msg, error,
12088c2ecf20Sopenharmony_ci			p->m.grp, p->m.pu, p->m.chk, p->m.sec);
12098c2ecf20Sopenharmony_ci	}
12108c2ecf20Sopenharmony_ci}
12118c2ecf20Sopenharmony_ci
12128c2ecf20Sopenharmony_cistatic inline void pblk_print_failed_rqd(struct pblk *pblk, struct nvm_rq *rqd,
12138c2ecf20Sopenharmony_ci					 int error)
12148c2ecf20Sopenharmony_ci{
12158c2ecf20Sopenharmony_ci	int bit = -1;
12168c2ecf20Sopenharmony_ci
12178c2ecf20Sopenharmony_ci	if (rqd->nr_ppas ==  1) {
12188c2ecf20Sopenharmony_ci		print_ppa(pblk, &rqd->ppa_addr, "rqd", error);
12198c2ecf20Sopenharmony_ci		return;
12208c2ecf20Sopenharmony_ci	}
12218c2ecf20Sopenharmony_ci
12228c2ecf20Sopenharmony_ci	while ((bit = find_next_bit((void *)&rqd->ppa_status, rqd->nr_ppas,
12238c2ecf20Sopenharmony_ci						bit + 1)) < rqd->nr_ppas) {
12248c2ecf20Sopenharmony_ci		print_ppa(pblk, &rqd->ppa_list[bit], "rqd", error);
12258c2ecf20Sopenharmony_ci	}
12268c2ecf20Sopenharmony_ci
12278c2ecf20Sopenharmony_ci	pblk_err(pblk, "error:%d, ppa_status:%llx\n", error, rqd->ppa_status);
12288c2ecf20Sopenharmony_ci}
12298c2ecf20Sopenharmony_ci
12308c2ecf20Sopenharmony_cistatic inline int pblk_boundary_ppa_checks(struct nvm_tgt_dev *tgt_dev,
12318c2ecf20Sopenharmony_ci				       struct ppa_addr *ppas, int nr_ppas)
12328c2ecf20Sopenharmony_ci{
12338c2ecf20Sopenharmony_ci	struct nvm_geo *geo = &tgt_dev->geo;
12348c2ecf20Sopenharmony_ci	struct ppa_addr *ppa;
12358c2ecf20Sopenharmony_ci	int i;
12368c2ecf20Sopenharmony_ci
12378c2ecf20Sopenharmony_ci	for (i = 0; i < nr_ppas; i++) {
12388c2ecf20Sopenharmony_ci		ppa = &ppas[i];
12398c2ecf20Sopenharmony_ci
12408c2ecf20Sopenharmony_ci		if (geo->version == NVM_OCSSD_SPEC_12) {
12418c2ecf20Sopenharmony_ci			if (!ppa->c.is_cached &&
12428c2ecf20Sopenharmony_ci					ppa->g.ch < geo->num_ch &&
12438c2ecf20Sopenharmony_ci					ppa->g.lun < geo->num_lun &&
12448c2ecf20Sopenharmony_ci					ppa->g.pl < geo->num_pln &&
12458c2ecf20Sopenharmony_ci					ppa->g.blk < geo->num_chk &&
12468c2ecf20Sopenharmony_ci					ppa->g.pg < geo->num_pg &&
12478c2ecf20Sopenharmony_ci					ppa->g.sec < geo->ws_min)
12488c2ecf20Sopenharmony_ci				continue;
12498c2ecf20Sopenharmony_ci		} else {
12508c2ecf20Sopenharmony_ci			if (!ppa->c.is_cached &&
12518c2ecf20Sopenharmony_ci					ppa->m.grp < geo->num_ch &&
12528c2ecf20Sopenharmony_ci					ppa->m.pu < geo->num_lun &&
12538c2ecf20Sopenharmony_ci					ppa->m.chk < geo->num_chk &&
12548c2ecf20Sopenharmony_ci					ppa->m.sec < geo->clba)
12558c2ecf20Sopenharmony_ci				continue;
12568c2ecf20Sopenharmony_ci		}
12578c2ecf20Sopenharmony_ci
12588c2ecf20Sopenharmony_ci		print_ppa(tgt_dev->q->queuedata, ppa, "boundary", i);
12598c2ecf20Sopenharmony_ci
12608c2ecf20Sopenharmony_ci		return 1;
12618c2ecf20Sopenharmony_ci	}
12628c2ecf20Sopenharmony_ci	return 0;
12638c2ecf20Sopenharmony_ci}
12648c2ecf20Sopenharmony_ci
12658c2ecf20Sopenharmony_cistatic inline int pblk_check_io(struct pblk *pblk, struct nvm_rq *rqd)
12668c2ecf20Sopenharmony_ci{
12678c2ecf20Sopenharmony_ci	struct nvm_tgt_dev *dev = pblk->dev;
12688c2ecf20Sopenharmony_ci	struct ppa_addr *ppa_list = nvm_rq_to_ppa_list(rqd);
12698c2ecf20Sopenharmony_ci
12708c2ecf20Sopenharmony_ci	if (pblk_boundary_ppa_checks(dev, ppa_list, rqd->nr_ppas)) {
12718c2ecf20Sopenharmony_ci		WARN_ON(1);
12728c2ecf20Sopenharmony_ci		return -EINVAL;
12738c2ecf20Sopenharmony_ci	}
12748c2ecf20Sopenharmony_ci
12758c2ecf20Sopenharmony_ci	if (rqd->opcode == NVM_OP_PWRITE) {
12768c2ecf20Sopenharmony_ci		struct pblk_line *line;
12778c2ecf20Sopenharmony_ci		int i;
12788c2ecf20Sopenharmony_ci
12798c2ecf20Sopenharmony_ci		for (i = 0; i < rqd->nr_ppas; i++) {
12808c2ecf20Sopenharmony_ci			line = pblk_ppa_to_line(pblk, ppa_list[i]);
12818c2ecf20Sopenharmony_ci
12828c2ecf20Sopenharmony_ci			spin_lock(&line->lock);
12838c2ecf20Sopenharmony_ci			if (line->state != PBLK_LINESTATE_OPEN) {
12848c2ecf20Sopenharmony_ci				pblk_err(pblk, "bad ppa: line:%d,state:%d\n",
12858c2ecf20Sopenharmony_ci							line->id, line->state);
12868c2ecf20Sopenharmony_ci				WARN_ON(1);
12878c2ecf20Sopenharmony_ci				spin_unlock(&line->lock);
12888c2ecf20Sopenharmony_ci				return -EINVAL;
12898c2ecf20Sopenharmony_ci			}
12908c2ecf20Sopenharmony_ci			spin_unlock(&line->lock);
12918c2ecf20Sopenharmony_ci		}
12928c2ecf20Sopenharmony_ci	}
12938c2ecf20Sopenharmony_ci
12948c2ecf20Sopenharmony_ci	return 0;
12958c2ecf20Sopenharmony_ci}
12968c2ecf20Sopenharmony_ci#endif
12978c2ecf20Sopenharmony_ci
12988c2ecf20Sopenharmony_cistatic inline int pblk_boundary_paddr_checks(struct pblk *pblk, u64 paddr)
12998c2ecf20Sopenharmony_ci{
13008c2ecf20Sopenharmony_ci	struct pblk_line_meta *lm = &pblk->lm;
13018c2ecf20Sopenharmony_ci
13028c2ecf20Sopenharmony_ci	if (paddr > lm->sec_per_line)
13038c2ecf20Sopenharmony_ci		return 1;
13048c2ecf20Sopenharmony_ci
13058c2ecf20Sopenharmony_ci	return 0;
13068c2ecf20Sopenharmony_ci}
13078c2ecf20Sopenharmony_ci
13088c2ecf20Sopenharmony_cistatic inline unsigned int pblk_get_bi_idx(struct bio *bio)
13098c2ecf20Sopenharmony_ci{
13108c2ecf20Sopenharmony_ci	return bio->bi_iter.bi_idx;
13118c2ecf20Sopenharmony_ci}
13128c2ecf20Sopenharmony_ci
13138c2ecf20Sopenharmony_cistatic inline sector_t pblk_get_lba(struct bio *bio)
13148c2ecf20Sopenharmony_ci{
13158c2ecf20Sopenharmony_ci	return bio->bi_iter.bi_sector / NR_PHY_IN_LOG;
13168c2ecf20Sopenharmony_ci}
13178c2ecf20Sopenharmony_ci
13188c2ecf20Sopenharmony_cistatic inline unsigned int pblk_get_secs(struct bio *bio)
13198c2ecf20Sopenharmony_ci{
13208c2ecf20Sopenharmony_ci	return  bio->bi_iter.bi_size / PBLK_EXPOSED_PAGE_SIZE;
13218c2ecf20Sopenharmony_ci}
13228c2ecf20Sopenharmony_ci
13238c2ecf20Sopenharmony_cistatic inline char *pblk_disk_name(struct pblk *pblk)
13248c2ecf20Sopenharmony_ci{
13258c2ecf20Sopenharmony_ci	struct gendisk *disk = pblk->disk;
13268c2ecf20Sopenharmony_ci
13278c2ecf20Sopenharmony_ci	return disk->disk_name;
13288c2ecf20Sopenharmony_ci}
13298c2ecf20Sopenharmony_ci
13308c2ecf20Sopenharmony_cistatic inline unsigned int pblk_get_min_chks(struct pblk *pblk)
13318c2ecf20Sopenharmony_ci{
13328c2ecf20Sopenharmony_ci	struct pblk_line_meta *lm = &pblk->lm;
13338c2ecf20Sopenharmony_ci	/* In a worst-case scenario every line will have OP invalid sectors.
13348c2ecf20Sopenharmony_ci	 * We will then need a minimum of 1/OP lines to free up a single line
13358c2ecf20Sopenharmony_ci	 */
13368c2ecf20Sopenharmony_ci
13378c2ecf20Sopenharmony_ci	return DIV_ROUND_UP(100, pblk->op) * lm->blk_per_line;
13388c2ecf20Sopenharmony_ci}
13398c2ecf20Sopenharmony_ci
13408c2ecf20Sopenharmony_cistatic inline struct pblk_sec_meta *pblk_get_meta(struct pblk *pblk,
13418c2ecf20Sopenharmony_ci							 void *meta, int index)
13428c2ecf20Sopenharmony_ci{
13438c2ecf20Sopenharmony_ci	return meta +
13448c2ecf20Sopenharmony_ci	       max_t(int, sizeof(struct pblk_sec_meta), pblk->oob_meta_size)
13458c2ecf20Sopenharmony_ci	       * index;
13468c2ecf20Sopenharmony_ci}
13478c2ecf20Sopenharmony_ci
13488c2ecf20Sopenharmony_cistatic inline int pblk_dma_meta_size(struct pblk *pblk)
13498c2ecf20Sopenharmony_ci{
13508c2ecf20Sopenharmony_ci	return max_t(int, sizeof(struct pblk_sec_meta), pblk->oob_meta_size)
13518c2ecf20Sopenharmony_ci	       * NVM_MAX_VLBA;
13528c2ecf20Sopenharmony_ci}
13538c2ecf20Sopenharmony_ci
13548c2ecf20Sopenharmony_cistatic inline int pblk_is_oob_meta_supported(struct pblk *pblk)
13558c2ecf20Sopenharmony_ci{
13568c2ecf20Sopenharmony_ci	return pblk->oob_meta_size >= sizeof(struct pblk_sec_meta);
13578c2ecf20Sopenharmony_ci}
13588c2ecf20Sopenharmony_ci#endif /* PBLK_H_ */
1359