tkl_storage.h

浏览该文件的文档.

 
#ifndef __TKL_STORAGE_H__
#define __TKL_STORAGE_H__
 
#include "tuya_cloud_types.h"
 
#ifdef __cplusplus
    extern "C" {
#endif
 
/* common filesystem name list */
#define FSTP_FAT32  "vfat" // fat32
#define FSTP_EXT34  "ext4"
#define FSTP_XFS    "xfs"
 
/* common storage bus type list */
#define BUSTP_USB       "usb"
#define BUSTP_SATA      "sata"
#define BUSTP_SDIO      "sdcard"
 
#define MAX_PATH_LEN        256
#define MAX_PART_NUM        10
#define MAX_DEVICE_NUM      10
#define MAX_FSTP_LEN        16
 
/* for disk partition add or delete */
#define PART_ADD    1
#define PART_DEL    2
 
#define DEVICE_HOTPLUG_ADD 1
#define DEVICE_HOTPLUG_DEL 0
 
typedef struct {
    CHAR_T dev_name[MAX_PATH_LEN];      /* device node name, eg. /dev/sda1 */
    CHAR_T fs_type[MAX_FSTP_LEN];       /* filesystem type. refer to common filesystem name list */
    UINT64_T size;                       /* total KB */
    UINT64_T used;                       /* used KB */
    UINT64_T avail;                      /* available KB */
    CHAR_T mounted_on[MAX_PATH_LEN];    /* mount point */
} TKL_STORAGE_DF_T;
 
 
typedef struct {
    CHAR_T dev_name[MAX_PATH_LEN];      /* device node name, eg. /dev/sda1 */
    UINT_T part_id;                     /* partition index */
    UINT64_T start;                     /* start position, KB, unsigned long long */
    UINT64_T end;                       /* end position, KB */
    UINT64_T size;                      /* partition size, KB */
    CHAR_T fs_type[MAX_FSTP_LEN];       /* filesystem type, eg. ext4 */
    CHAR_T part_label[16];              /* partition label */
    CHAR_T flags[16];                   /* partition flags, eg. bios_grub */
} TKL_STORAGE_PART_INFO_T;
 
 
typedef struct {
    UINT_T slot;                        /* hardware slot number */
    UINT_T major;                       /* device major id */
    UINT_T minor;                       /* device minor id */
    CHAR_T bus_type[8];                 /* interface type, eg. usb sata sd */
    CHAR_T model[16];                   /* storage model, optional */
    CHAR_T dev_name[MAX_PATH_LEN];      /* device node, eg. /dev/sda */
    UINT64_T capacity;                   /* total size, KB */
    UINT_T sect_size;                   /* sector size, bytes */
    CHAR_T part_table_type[16];         /* partition table type, eg. gpt mbr private */
    CHAR_T dev_id[64];                  /* disk identifier, eg. 330BD448-E0FC-46ED-BC7E-67D75DDA5572 */
} TKL_STORAGE_DEVICE_INFO_T;
 
typedef enum {
    EVT_HOTPLUG,
    EVT_FS_ERR, // eg. ro
} TKL_STORAGE_EVT_MSGTP;
 
typedef struct {
    CHAR_T bus_type[8];
    CHAR_T dev_name[MAX_PATH_LEN];
    TKL_STORAGE_EVT_MSGTP type;
    union {
        INT_T i;
        CHAR_T s[64];
    } msg;
} TKL_STORAGE_EVENT_MSG;
 
 
/* progress bar in case of long time operations */
typedef VOID (*TKL_STORAGE_PROGRESS_CB)(INT_T progress, VOID *user_ctx);
 
/* common storage device event */
typedef VOID (*TKL_STORAGE_EVENT_CB)(TKL_STORAGE_EVENT_MSG *msg, VOID *user_ctx);
 
/* return badblock index in blk_idx  */
typedef VOID (*TKL_STORAGE_BADBLK_CB)(ULONG_T blk_idx, VOID *user_ctx);
 
 
OPERATE_RET tkl_storage_get_internal_dir(CHAR_T path[MAX_PATH_LEN]);
 
 
OPERATE_RET tkl_storage_df(CHAR_T *mount_point, TKL_STORAGE_DF_T *df);
 
 
OPERATE_RET tkl_storage_get_device_info(CHAR_T *dev_name, TKL_STORAGE_DEVICE_INFO_T *list);
 
 
OPERATE_RET tkl_storage_get_device_list(TKL_STORAGE_DEVICE_INFO_T *list, INT_T num);
 
 
OPERATE_RET tkl_storage_get_part_list(CHAR_T *dev_name, TKL_STORAGE_PART_INFO_T *list, INT_T num);
 
 
 OPERATE_RET tkl_storage_make_part(CHAR_T *part_name, CHAR_T *part_type,
    CHAR_T *fs_type, BOOL_T isadd, UINT_T part_index, LONG_T start, LONG_T end);
 
 OPERATE_RET tkl_storage_mkfs(CHAR_T *fs_type, CHAR_T *fs_dev, CHAR_T *parm,
    TKL_STORAGE_PROGRESS_CB cb, VOID *user_ctx);
 
OPERATE_RET tkl_storage_mount(CHAR_T *source, CHAR_T *target,
    CHAR_T *fs_type, ULONG_T flags, VOID *data);
 
 
OPERATE_RET tkl_storage_umount(CHAR_T *target, INT_T flags);
 
 
OPERATE_RET tkl_storage_loop_event(TKL_STORAGE_EVENT_CB event_cb, VOID *user_ctx);
 
 
 OPERATE_RET tkl_storage_fsck(CHAR_T *blk_dev, CHAR_T *fs_type, CHAR_T *parm, INT_T flags,
    TKL_STORAGE_PROGRESS_CB cb, VOID *user_ctx);
 
 
OPERATE_RET tkl_storage_ioctl(CHAR_T *dev_name, ULONG_T request, VOID *args);
 
 
/* medium-specific interfaces */
 
OPERATE_RET tkl_storage_check_badblocks(CHAR_T *dev_name, TKL_STORAGE_BADBLK_CB cb, VOID *user_ctx);
 
#ifdef __cplusplus
}
#endif
 
#endif