mirror of
https://github.com/edk2-porting/linux-next.git
synced 2024-12-28 15:13:55 +08:00
e3eb3799f7
An Open-Channel SSD shall be initialized before use. To initialize, we define an on-disk format, that keeps a small set of metadata to bring up the media manager on top of the device. The initial step is introduced to allow a user to format the disks for a given media manager. During format, a system block is stored on one to three separate luns on the device. Each lun has the system block duplicated. During initialization, the system block can be retrieved and the appropriate media manager can initialized. The on-disk format currently covers (struct nvm_system_block): - Magic value "NVMS". - Monotonic increasing sequence number. - The physical block erase count. - Version of the system block format. - Media manager type. - Media manager superblock physical address. The interface provides three functions to manage the system block: int nvm_init_sysblock(struct nvm_dev *, struct nvm_sb_info *) int nvm_get_sysblock(struct nvm *dev, struct nvm_sb_info *) int nvm_update_sysblock(struct nvm *dev, struct nvm_sb_info *) Each implement a part of the logic to manage the system block. The initialization creates the first system blocks and mark them on the device. Get retrieves the latest system block by scanning all pages in the associated system blocks. The update sysblock writes new metadata and allocates new block if necessary. Signed-off-by: Matias Bjørling <m@bjorling.me> Signed-off-by: Jens Axboe <axboe@fb.com>
132 lines
3.0 KiB
C
132 lines
3.0 KiB
C
/*
|
|
* Copyright (C) 2015 CNEX Labs. All rights reserved.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License version
|
|
* 2 as published by the Free Software Foundation.
|
|
*
|
|
* 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.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; see the file COPYING. If not, write to
|
|
* the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139,
|
|
* USA.
|
|
*/
|
|
|
|
#ifndef _UAPI_LINUX_LIGHTNVM_H
|
|
#define _UAPI_LINUX_LIGHTNVM_H
|
|
|
|
#ifdef __KERNEL__
|
|
#include <linux/kernel.h>
|
|
#include <linux/ioctl.h>
|
|
#else /* __KERNEL__ */
|
|
#include <stdio.h>
|
|
#include <sys/ioctl.h>
|
|
#define DISK_NAME_LEN 32
|
|
#endif /* __KERNEL__ */
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/ioctl.h>
|
|
|
|
#define NVM_TTYPE_NAME_MAX 48
|
|
#define NVM_TTYPE_MAX 63
|
|
#define NVM_MMTYPE_LEN 8
|
|
|
|
#define NVM_CTRL_FILE "/dev/lightnvm/control"
|
|
|
|
struct nvm_ioctl_info_tgt {
|
|
__u32 version[3];
|
|
__u32 reserved;
|
|
char tgtname[NVM_TTYPE_NAME_MAX];
|
|
};
|
|
|
|
struct nvm_ioctl_info {
|
|
__u32 version[3]; /* in/out - major, minor, patch */
|
|
__u16 tgtsize; /* number of targets */
|
|
__u16 reserved16; /* pad to 4K page */
|
|
__u32 reserved[12];
|
|
struct nvm_ioctl_info_tgt tgts[NVM_TTYPE_MAX];
|
|
};
|
|
|
|
enum {
|
|
NVM_DEVICE_ACTIVE = 1 << 0,
|
|
};
|
|
|
|
struct nvm_ioctl_device_info {
|
|
char devname[DISK_NAME_LEN];
|
|
char bmname[NVM_TTYPE_NAME_MAX];
|
|
__u32 bmversion[3];
|
|
__u32 flags;
|
|
__u32 reserved[8];
|
|
};
|
|
|
|
struct nvm_ioctl_get_devices {
|
|
__u32 nr_devices;
|
|
__u32 reserved[31];
|
|
struct nvm_ioctl_device_info info[31];
|
|
};
|
|
|
|
struct nvm_ioctl_create_simple {
|
|
__u32 lun_begin;
|
|
__u32 lun_end;
|
|
};
|
|
|
|
enum {
|
|
NVM_CONFIG_TYPE_SIMPLE = 0,
|
|
};
|
|
|
|
struct nvm_ioctl_create_conf {
|
|
__u32 type;
|
|
union {
|
|
struct nvm_ioctl_create_simple s;
|
|
};
|
|
};
|
|
|
|
struct nvm_ioctl_create {
|
|
char dev[DISK_NAME_LEN]; /* open-channel SSD device */
|
|
char tgttype[NVM_TTYPE_NAME_MAX]; /* target type name */
|
|
char tgtname[DISK_NAME_LEN]; /* dev to expose target as */
|
|
|
|
__u32 flags;
|
|
|
|
struct nvm_ioctl_create_conf conf;
|
|
};
|
|
|
|
struct nvm_ioctl_remove {
|
|
char tgtname[DISK_NAME_LEN];
|
|
|
|
__u32 flags;
|
|
};
|
|
|
|
|
|
/* The ioctl type, 'L', 0x20 - 0x2F documented in ioctl-number.txt */
|
|
enum {
|
|
/* top level cmds */
|
|
NVM_INFO_CMD = 0x20,
|
|
NVM_GET_DEVICES_CMD,
|
|
|
|
/* device level cmds */
|
|
NVM_DEV_CREATE_CMD,
|
|
NVM_DEV_REMOVE_CMD,
|
|
};
|
|
|
|
#define NVM_IOCTL 'L' /* 0x4c */
|
|
|
|
#define NVM_INFO _IOWR(NVM_IOCTL, NVM_INFO_CMD, \
|
|
struct nvm_ioctl_info)
|
|
#define NVM_GET_DEVICES _IOR(NVM_IOCTL, NVM_GET_DEVICES_CMD, \
|
|
struct nvm_ioctl_get_devices)
|
|
#define NVM_DEV_CREATE _IOW(NVM_IOCTL, NVM_DEV_CREATE_CMD, \
|
|
struct nvm_ioctl_create)
|
|
#define NVM_DEV_REMOVE _IOW(NVM_IOCTL, NVM_DEV_REMOVE_CMD, \
|
|
struct nvm_ioctl_remove)
|
|
|
|
#define NVM_VERSION_MAJOR 1
|
|
#define NVM_VERSION_MINOR 0
|
|
#define NVM_VERSION_PATCHLEVEL 0
|
|
|
|
#endif
|