dao_blk_dev.h

/* SPDX-License-Identifier: Marvell-Proprietary
 * Copyright (c) 2025 Marvell
 */
 
#ifndef __INCLUDE_DAO_BLK_DEV_H__
#define __INCLUDE_DAO_BLK_DEV_H__
 
#include <stdint.h>
#include <stdio.h>
 
#define DAO_BLKDEV_MAX           (128)
#define DAO_MAX_BLKDEV_ID_STRLEN (20)
#define DAO_BLK_REQ_SECTOR_SHIFT (9) /* 512 bytes sector size */
 
typedef enum dao_blkdev_type {
    DAO_BLK_DEV_RAMDISK = 1,
} dao_blkdev_type_t;
 
typedef struct {
    uint64_t read_ops;
    uint64_t write_ops;
    uint64_t bytes_read;
    uint64_t bytes_written;
    uint64_t flush_ops;
    uint64_t reset_ops;
    uint64_t unmap_ops;
    uint64_t write_zeroes_ops;
} dao_blkdev_stats_t;
 
typedef struct blk_iobuf_ptr {
    void *data;
    uint32_t size;
} blk_iobuf_ptr_t;
 
typedef struct dao_blk_io_vec {
    uint32_t buf_cnt;
    blk_iobuf_ptr_t *bufs;
} dao_blk_io_vec_t;
 
struct dao_blkdev_conf {
    uint64_t capacity;
    uint32_t blk_size;
    uint8_t dev_type;
};
 
/* End of structure dao_blkdev_conf. */
 
typedef struct {
    int (*read)(uint16_t devid, uint64_t sector, dao_blk_io_vec_t *iov, size_t len);
    int (*write)(uint16_t devid, uint64_t sector, dao_blk_io_vec_t *iov, size_t len);
    int (*flush)(uint16_t devid);
    int (*reset)(uint16_t devid);
    int (*unmap)(uint16_t devid, uint64_t sector, size_t len);
    int (*write_zeroes)(uint16_t devid, uint64_t sector, size_t len, uint8_t unmap);
    int (*get_id)(uint16_t devid, char *name, size_t max_len);
    int (*discard)(uint16_t devid, uint64_t sector, size_t len);
    void (*get_stats)(uint16_t devid, dao_blkdev_stats_t *stats);
    void (*clear_stats)(uint16_t devid);
    void (*get_features)(uint16_t devid, uint64_t *feat);
} dao_blkdev_handlers_t;
 
typedef struct dao_blkdev {
    dao_blkdev_handlers_t *handlers;
    void *priv_data;
    uint32_t sector_size;
    uint32_t dev_id;
    uint8_t dev_type;
} dao_blkdev_t;
 
extern struct dao_blkdev dao_blkdevs[];
 
typedef enum dao_blkdev_req_status {
    DAO_BLK_DEV_REQ_COMPGOOD,
    DAO_BLK_DEV_REQ_FAIL,
    DAO_BLK_DEV_REQ_UNSUPPORTED,
    DAO_BLK_DEV_REQ_IN_PROCESS
} dao_blkdev_req_status_t;
 
int dao_blkdev_create(uint16_t dev_id, struct dao_blkdev_conf *conf,
              const char *name);
 
int dao_blkdev_destroy(uint16_t devid);
 
int dao_blkdev_read(uint16_t devid, uint64_t sector, dao_blk_io_vec_t *iov, size_t len);
 
int dao_blkdev_write(uint16_t devid, uint64_t sector, dao_blk_io_vec_t *iov, size_t len);
 
int dao_blkdev_flush(uint16_t devid);
 
int dao_blkdev_reset(uint16_t devid);
 
int dao_blkdev_unmap(uint16_t devid, uint64_t sector, size_t len);
 
int dao_blkdev_write_zeroes(uint16_t devid, uint64_t sector, size_t len, uint8_t unmap);
 
int dao_blkdev_get_id(uint16_t devid, char *name, size_t max_len);
 
int dao_blkdev_discard(uint16_t devid, uint64_t sector, size_t len);
 
void dao_blkdev_get_stats(uint16_t devid, dao_blkdev_stats_t *stats);
 
void dao_blkdev_clear_stats(uint16_t devid);
 
int dao_blkdev_type_from_str(const char *type);
 
const char *dao_blkdev_type_to_str(int type);
#endif