hw/block/nvme-ns.h

   1 /*
   2  * QEMU NVM Express Virtual Namespace
   3  *
   4  * Copyright (c) 2019 CNEX Labs
   5  * Copyright (c) 2020 Samsung Electronics
   6  *
   7  * Authors:
   8  *  Klaus Jensen      <k.jensen@samsung.com>
   9  *
  10  * This work is licensed under the terms of the GNU GPL, version 2. See the
  11  * COPYING file in the top-level directory.
  12  *
  13  */
  14
  15 #ifndef NVME_NS_H
  16 #define NVME_NS_H
  17
  18 #define TYPE_NVME_NS "nvme-ns"
  19 #define NVME_NS(obj) \
  20     OBJECT_CHECK(NvmeNamespace, (obj), TYPE_NVME_NS)
  21
  22 typedef struct NvmeNamespaceParams {
  23     uint32_t nsid;
  24 } NvmeNamespaceParams;
  25
  26 typedef struct NvmeNamespace {
  27     DeviceState  parent_obj;
  28     BlockConf    blkconf;
  29     int32_t      bootindex;
  30     int64_t      size;
  31     NvmeIdNs     id_ns;
  32
  33     NvmeNamespaceParams params;
  34 } NvmeNamespace;
  35
  36 static inline uint32_t nvme_nsid(NvmeNamespace *ns)
  37 {
  38     if (ns) {
  39         return ns->params.nsid;
  40     }
  41
  42     return -1;
  43 }
  44
  45 static inline NvmeLBAF *nvme_ns_lbaf(NvmeNamespace *ns)
  46 {
  47     NvmeIdNs *id_ns = &ns->id_ns;
  48     return &id_ns->lbaf[NVME_ID_NS_FLBAS_INDEX(id_ns->flbas)];
  49 }
  50
  51 static inline uint8_t nvme_ns_lbads(NvmeNamespace *ns)
  52 {
  53     return nvme_ns_lbaf(ns)->ds;
  54 }
  55
  56 /* calculate the number of LBAs that the namespace can accomodate */
  57 static inline uint64_t nvme_ns_nlbas(NvmeNamespace *ns)
  58 {
  59     return ns->size >> nvme_ns_lbads(ns);
  60 }
  61
  62 /* convert an LBA to the equivalent in bytes */
  63 static inline size_t nvme_l2b(NvmeNamespace *ns, uint64_t lba)
  64 {
  65     return lba << nvme_ns_lbads(ns);
  66 }
  67
  68 typedef struct NvmeCtrl NvmeCtrl;
  69
  70 int nvme_ns_setup(NvmeCtrl *n, NvmeNamespace *ns, Error **errp);
  71 void nvme_ns_drain(NvmeNamespace *ns);
  72 void nvme_ns_flush(NvmeNamespace *ns);
  73
  74 #endif /* NVME_NS_H */