bsl_ui.h

/*
 * This file is part of the openHiTLS project.
 *
 * openHiTLS is licensed under the Mulan PSL v2.
 * You can use this software according to the terms and conditions of the Mulan PSL v2.
 * You may obtain a copy of Mulan PSL v2 at:
 *
 *     http://license.coscl.org.cn/MulanPSL2
 *
 * THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
 * EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 * MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 * See the Mulan PSL v2 for more details.
 */
#ifndef BSL_UI_H
#define BSL_UI_H
 
#include <stdint.h>
#include <stdbool.h>
#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    BSL_UIM_NONE = 0,
    BSL_UIM_OPEN,
    BSL_UIM_WRITE,
    BSL_UIM_READ,
    BSL_UIM_CLOSE
} BSL_UI_MethodTypes;

typedef enum {
    BSL_UI_DATA_NONE = 0,
    BSL_UI_DATA_READ,
    BSL_UI_DATA_WRITE
} BSL_UI_DataTypes;

typedef enum {
    BSL_UI_DATA_FLAG_NONE = 0, // Setting the Echo Display 01, follow with 010 0100
    BSL_UI_DATA_FLAG_ECHO = 0x1,
    BSL_UI_DATA_FLAG_USER = 0x10000
} BSL_UI_DataFlags;

typedef struct {
    uint32_t flags;
    char *buff;
    uint32_t buffLen;
    char *verifyBuff;
} BSL_UI_CtrlRGetParam;

typedef struct {
    const char *desc;
    const char *name;
    bool verify;
} BSL_UI_ReadPwdParam;
 
typedef struct UI_Control BSL_UI;
typedef struct UI_ControlMethod BSL_UI_Method;
typedef struct UI_ControlDataPack BSL_UI_DataPack;

typedef int32_t (*BSL_UI_Open) (BSL_UI *ui);

typedef int32_t (*BSL_UI_Write) (BSL_UI *ui, BSL_UI_DataPack *data);

typedef int32_t (*BSL_UI_Read) (BSL_UI *ui, BSL_UI_DataPack *data);

typedef int32_t (*BSL_UI_Close) (BSL_UI *ui);

typedef int32_t (*BSL_UI_CheckDataCallBack) (BSL_UI *ui, char *buff, uint32_t buffLen, void *callBackData);

BSL_UI *BSL_UI_New(const BSL_UI_Method *method);

void BSL_UI_Free(BSL_UI *ui);

BSL_UI_Method *BSL_UI_MethodNew(void);

void BSL_UI_MethodFree(BSL_UI_Method *method);

const BSL_UI_Method *BSL_UI_GetOperMethod(const BSL_UI *ui);

int32_t BSL_UI_SetMethod(BSL_UI_Method *method, uint8_t type, void *func);

int32_t BSL_UI_GetMethod(const BSL_UI_Method *method, uint8_t type, void **func);

int32_t BSL_UI_ReadPwdUtil(BSL_UI_ReadPwdParam *param, char *buff, uint32_t *buffLen,
    const BSL_UI_CheckDataCallBack checkDataCallBack, void *callBackData);

BSL_UI_DataPack *BSL_UI_DataPackNew(void);

void BSL_UI_DataPackFree(BSL_UI_DataPack *data);

int32_t BSL_UI_DataCtrl(BSL_UI_DataPack *data, uint32_t type, void *parg, uint32_t larg);

int32_t BSL_UI_GetDataResult(BSL_UI_DataPack *data, char **result, uint32_t *resultLen);

char *BSL_UI_ConstructPrompt(const char *objectDesc, const char *objectName);
 
#ifdef __cplusplus
}
#endif
 
#endif