request_format.h

Go to the documentation of this file.

 
// request_format.h for Cosmos+ OpenSSD
// Copyright (c) 2017 Hanyang University ENC Lab.
// Contributed by Yong Ho Song <yhsong@enc.hanyang.ac.kr>
//                Jaewook Kwak <jwkwak@enc.hanyang.ac.kr>
//
// This file is part of Cosmos+ OpenSSD.
//
// Cosmos+ OpenSSD 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 3, or (at your option)
// any later version.
//
// Cosmos+ OpenSSD 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 Cosmos+ OpenSSD; see the file COPYING.
// If not, see <http://www.gnu.org/licenses/>.
 
// Company: ENC Lab. <http://enc.hanyang.ac.kr>
// Engineer: Jaewook Kwak <jwkwak@enc.hanyang.ac.kr>
//
// Project Name: Cosmos+ OpenSSD
// Design Name: Cosmos+ Firmware
// Module Name: Request Allocator
// File Name: request_format.h
//
// Version: v1.0.0
//
// Description:
//   - define parameters, data structure of request
 
// Revision History:
//
// * v1.0.0
//   - First draft
 
#ifndef REQUEST_FORMAT_H_
#define REQUEST_FORMAT_H_
 
#include "nvme/nvme.h"
 
#define REQ_TYPE_SLICE    0x0
#define REQ_TYPE_NAND     0x1 // flash or flash DMA operation
#define REQ_TYPE_NVME_DMA 0x2 // host DMA
 
#define REQ_QUEUE_TYPE_NONE                    0x0
#define REQ_QUEUE_TYPE_FREE                    0x1
#define REQ_QUEUE_TYPE_SLICE                   0x2
#define REQ_QUEUE_TYPE_BLOCKED_BY_BUF_DEP      0x3
#define REQ_QUEUE_TYPE_BLOCKED_BY_ROW_ADDR_DEP 0x4
#define REQ_QUEUE_TYPE_NVME_DMA                0x5
#define REQ_QUEUE_TYPE_NAND                    0x6
 
#define REQ_CODE_WRITE         0x00
#define REQ_CODE_READ          0x08 // read trigger
#define REQ_CODE_READ_TRANSFER 0x09 // read transfer
#define REQ_CODE_ERASE         0x0C
#define REQ_CODE_RESET         0x0D // currently only used in FTL initialization stage
#define REQ_CODE_SET_FEATURE   0x0E // currently only used in FTL initialization stage
#define REQ_CODE_FLUSH         0x0F
#define REQ_CODE_RxDMA         0x10
#define REQ_CODE_TxDMA         0x20
 
#define REQ_CODE_OCSSD_PHY_TYPE_BASE 0xA0
#define REQ_CODE_OCSSD_PHY_WRITE     0xA0
#define REQ_CODE_OCSSD_PHY_READ      0xA8
#define REQ_CODE_OCSSD_PHY_ERASE     0xAC
 
#define REQ_OPT_DATA_BUF_ENTRY      0 // View `dataBufFormat` as buffer entry index, used by most requests.
#define REQ_OPT_DATA_BUF_TEMP_ENTRY 1 // View `dataBufFormat` as buffer entry index, used by GC only.
#define REQ_OPT_DATA_BUF_ADDR       2 // View `dataBufFormat` as DRAM address, currently used by BBT only.
#define REQ_OPT_DATA_BUF_NONE       3 // for ERASE, RESET, SET_FEATURE (no buffer needed).
 
#define REQ_OPT_NAND_ADDR_VSA     0 // the data stored in `nandInfo` is Virtual Slice Address.
#define REQ_OPT_NAND_ADDR_PHY_ORG 1 // the data stored in `nandInfo` is Physical Flash Info.
 
#define REQ_OPT_NAND_ECC_OFF 0
#define REQ_OPT_NAND_ECC_ON  1
 
#define REQ_OPT_NAND_ECC_WARNING_OFF 0
#define REQ_OPT_NAND_ECC_WARNING_ON  1
 
#define REQ_OPT_WRAPPING_NONE 0
#define REQ_OPT_WRAPPING_REQ  1
 
// no need to check dep for this request, may be used by information related operations.
#define REQ_OPT_ROW_ADDR_DEPENDENCY_NONE 0
// we should check dep for this request, basically was used by NAND I/O operations.
#define REQ_OPT_ROW_ADDR_DEPENDENCY_CHECK 1
 
#define REQ_OPT_BLOCK_SPACE_MAIN  0 // main blocks only
#define REQ_OPT_BLOCK_SPACE_TOTAL 1 // main blocks and extended blocks
 
#define LOGICAL_SLICE_ADDR_NONE 0xffffffff
 
typedef struct _DATA_BUF_INFO
{
    union
    {
        unsigned int addr;  // real buffer address (16384+256 bytes for data and spare region)
        unsigned int entry; // data buffer entry index
    };
} DATA_BUF_INFO, *P_DATA_BUF_INFO;
 
typedef struct _NVME_DMA_INFO
{
    unsigned int startIndex : 16;      // which NVMe block should the slice request transfer from/to
    unsigned int nvmeBlockOffset : 16; // which slice request offset should the first NVMe block aligned to
    unsigned int numOfNvmeBlock : 16;  // how many NVMe blocks should be transferred, 1 based
    unsigned int reqTail : 8;          // the tail index of the NVMe auto DMA queue
    unsigned int reserved0 : 8;        // reserved
    unsigned int overFlowCnt;          // TODO
} NVME_DMA_INFO, *P_NVME_DMA_INFO;
 
typedef struct _NAND_INFO
{
    union
    {
        unsigned int virtualSliceAddr; // location vector mention in paper
        struct
        {
            unsigned int physicalCh : 4;
            unsigned int physicalWay : 4;
            unsigned int physicalBlock : 16;
            unsigned int phyReserved0 : 8;
        };
    };
    union
    {
        unsigned int programmedPageCnt;
        struct
        {
            unsigned int physicalPage : 16;
            unsigned int phyReserved1 : 16;
        };
    };
} NAND_INFO, *P_NAND_INFO;
 
typedef struct _REQ_OPTION
{
    unsigned int dataBufFormat : 2;
 
    unsigned int nandAddr : 2;
    unsigned int nandEcc : 1;                // 0 for OFF, 1 for ON
    unsigned int nandEccWarning : 1;         // 0 for OFF, 1 for ON
    unsigned int rowAddrDependencyCheck : 1; // whether this request needs to check dependency.
    unsigned int blockSpace : 1;             // 0 for MAIN, 1 for TOTAL
    unsigned int reserved0 : 24;
} REQ_OPTION, *P_REQ_OPTION; /* NOTE: 32 bits */
 
typedef struct _SSD_REQ_FORMAT
{
    unsigned int reqType : 4;         // the type of this request. Slice, NAND or NVMe command.
    unsigned int reqQueueType : 4;    // the type of request queue where this request is stored
    unsigned int reqCode : 8;         // READ/WRITE/RxDMA/TxDMA/etc. (check REQ_CODE_*)
    unsigned int nvmeCmdSlotTag : 16; // TODO
 
    unsigned int logicalSliceAddr;
 
    REQ_OPTION reqOpt;         // optional request configs
    DATA_BUF_INFO dataBufInfo; // request data buffer entry info of this request
    NVME_DMA_INFO nvmeDmaInfo; // NVMe requests related info
    NAND_INFO nandInfo;        // address info of this NAND request
 
    unsigned int prevReq : 16;         // the request pool index of prev request queue entry
    unsigned int nextReq : 16;         // the request pool index of next request queue entry
    unsigned int prevBlockingReq : 16; // request entry index of the prev request in blocking request queue
    unsigned int nextBlockingReq : 16; // request entry index of the next request in blocking request queue
 
    // 4 4 8+4+12+8 8 Bytes
 
} SSD_REQ_FORMAT, *P_SSD_REQ_FORMAT;
 
#endif /* REQUEST_FORMAT_H_ */