MAGResWCH.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef MAGRESWCH_EXPORTS
#define MAGRESWCH_API __declspec(dllexport)
#else
#define MAGRESWCH_API __declspec(dllimport)
#endif
 
 
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif

typedef struct dio_handle_s *dio_handle_h;

typedef struct dio_bmp_s *dio_bmp_h;

typedef enum {
  ERR_CANNOT_ALLOCATE_LPNMASTERHANDLE = -1,
  ERR_INVALID_CH367_HANDLE = -2,
  ERR_CANNOT_GET_IO_REG_ADDR = -3,
  ERR_STEP_SIZE_LESS_EQUAL_ZERO = -4,
  ERR_WRITE_LONGER_THAN_AVAIL_MEM = -5,
  ERR_WRITE_ZERO_BYTES = -6,
  ERR_READ_ZERO_BYTES = -7,
  ERR_SPI_READ_ERR = -8,
  ERR_SPI_STREAM_ERR = -9,
  ERR_SPI_WRITE_ERR = -10,
  ERR_SPI_ADDR_OUT_OF_BOUNDS = -11,
  ERR_BMP_INVALID_FILE = -12
} dio_errors_e;

typedef enum {
  DIO_EXT_TRIG_IGNORE = 0,
  DIO_EXT_TRIG_RISING_EDGE,
  DIO_EXT_TRIG_FALLING_EDGE,
  DIO_EXT_TRIG_HIGH_HOLD,
  DIO_EXT_TRIG_LOW_HOLD
} dio_ext_trigger_modes_e;
 
 
typedef enum {
  DIO_ADRSR_PIN_LOW = 0,
  DIO_ADRSR_PIN_HIGH
} dio_adrsr_pin_state_e;

typedef enum {
  DIO_OLED_MODE_OVERWRITE = 0,
  DIO_OLED_MODE_OR,
  DIO_OLED_MODE_GREATER_THAN,
  DIO_OLED_MODE_XOR,
  DIO_OLED_MODE_NONZERO
} dio_oled_write_mode_e;
 
/*
typedef enum {
  DIO_OLED_BUFF_SEND_MODE_FULL = 0, //sends the full buffer
  DIO_OLED_BUFF_SEND_MODE_DIRTY, //sends the 'dirty area' of the buffer
  DIO_OLED_BUFF_SEND_MODE_QUAD_1 //divides into quads and sends dirty quad
} dio_oled_buff_send_mode;
*/

MAGRESWCH_API void DioInitialize(short nMasterNum, dio_handle_h *lpnMasterHandle, int16_t* lpnStatus);

MAGRESWCH_API void DioArm(dio_handle_h nMasterHandle, int16_t* lpnStatus);

MAGRESWCH_API void DioHalt(dio_handle_h nMasterHandle, int16_t* lpnStatus);

MAGRESWCH_API void DioPause (dio_handle_h nMasterHandle, int16_t* lpnStatus);
 

MAGRESWCH_API void DioTrig(dio_handle_h nMasterHandle,
    int16_t* lpnStatus);

MAGRESWCH_API void DioReadCtrlMemory (dio_handle_h nHandle,
    uint32_t* lnpdwVector,
    uint32_t dwStart,
    uint32_t dwSize,
    int16_t* lpnStatus);
 

MAGRESWCH_API void DioReadOutMemory (dio_handle_h nHandle,
    uint32_t* lnpdwVector,
    uint32_t dwStart,
    uint32_t dwSize,
    int16_t* lpnStatus);
 

MAGRESWCH_API void DioWriteCtrlMemory(dio_handle_h nHandle,
    uint32_t* lpdwMemory,
    uint32_t dwStart,
    uint32_t dwSize,
    int16_t* lpnStatus);

MAGRESWCH_API void DioWriteOutMemory(dio_handle_h nHandle,
    uint32_t* lpdwMemory,
    uint32_t dwStart,
    uint32_t dwSize,
    int16_t* lpnStatus);

MAGRESWCH_API void DioReadProgramCounter(dio_handle_h nHandle,
    int32_t* lpdwCounter,
    int16_t* lpnStatus);

MAGRESWCH_API void DioWriteProgramCounter(dio_handle_h nHandle,
    int32_t dwCounter,
    int16_t* lpnStatus);

MAGRESWCH_API void DioReadCurrentIO(dio_handle_h nHandle,
    int32_t* lpdwCounter,
    int16_t* lpnStatus);

MAGRESWCH_API void DioWriteCurrentIO(dio_handle_h nHandle,
    int32_t dwCounter,
    int16_t* lpnStatus);
 
 

MAGRESWCH_API void DioReadStatusRegister(dio_handle_h nHandle,
    int16_t* lpwData,
    int16_t* lpnStatus);
 
 
/*
 * @brief Reads/writes x register from/to the specified board
 *
 * called to simulate external event lines value.
 *
 * @param nHandle     master board handle
 * @param lpwData     returned register value
 * @param wData       value to be written
 * @param lpnStatus   returned status, 0 on success, < 0 failure.
 */
/*
MAGRESWCH_API void DioReadXRegister(dio_handle_h nHandle,
    int32_t* lpwData,
    int16_t* lpnStatus);
 
MAGRESWCH_API void DioWriteXRegister(dio_handle_h nHandle,
    int32_t* wData,
    int16_t* lpnStatus);
    */
 

MAGRESWCH_API void DioReset(dio_handle_h nHandle,
    int16_t* lpnStatus);
 
/*
 * @brief Sets up the specified master board external event lines trigger mode
 *
 * DioTrig function or the external trigger control line can trigger the board
 * regardless of the trigger mode set by this function. Board must be in a PAUSE
 * state to enable triggering.
 *
 * @param nHandle     master board handle
 * @param nMode       specifies one of several trigger modes
 * @param lpnStatus   returned status, 0 on success, < 0 failure.
 */
/*
MAGRESWCH_API void DioSetupTriggerMode(dio_handle_h nHandle,
    int16_t nMode,
    int16_t* lpnStatus);
    */
 
 
/*
 * @brief Sets up the specified master board external event lines source.
 *
 *
 * @param nMasterHandle master board handle
 * @param nSource       0 source is external event lines/1 X register
 * @param lpnStatus     returned status, 0 on success, < 0 failure.
 */
/*
MAGRESWCH_API void DioSetupTriggerXEventSource(dio_handle_h nMasterHandle,
    int16_t nSource,
    int16_t* lpnStatus);
    */

MAGRESWCH_API void DioStep(dio_handle_h nMasterHandle,
    int32_t dwSteps,
    int16_t* lpnStatus);

MAGRESWCH_API void DioReadMaxDataLines(dio_handle_h nHandle,
    int32_t* lpdwCounter,
    int16_t* lpnStatus);
 

MAGRESWCH_API void DioClearCtrlMemory(dio_handle_h nMasterHandle, int16_t* lpnStatus);

MAGRESWCH_API void DioClearOutMemory(dio_handle_h nMasterHandle, int16_t* lpnStatus);
 

MAGRESWCH_API void DioStreamSPI(dio_handle_h nMasterHandle,
    uint8_t addr,
    uint8_t *write_buff,
    uint8_t *read_buff,
    size_t len,
    int16_t* lpnStatus);

MAGRESWCH_API void DioWriteSPI(dio_handle_h nMasterHandle,
    uint8_t addr,
    uint8_t *write_buff,
    size_t len,
    int16_t* lpnStatus);

MAGRESWCH_API void DioReadSPI(dio_handle_h nMasterHandle,
    uint8_t addr,
    uint8_t *read_buff,
    size_t len,
    int16_t* lpnStatus);

MAGRESWCH_API void DioResetDDS(dio_handle_h nMasterHandle, int16_t* lpnStatus);

MAGRESWCH_API void DioSetupTriggerMode(dio_handle_h nMasterHandle,
    uint8_t nPauseMode,
    uint8_t nRunMode,
    int16_t* lpnstatus);

MAGRESWCH_API void DioClose(dio_handle_h nMasterHandle, int16_t* lpnStatus);
 
MAGRESWCH_API void DioSetADRSR_Low(dio_handle_h nMasterHandle, uint8_t io_byte);
MAGRESWCH_API void DioSetADRSR_High(dio_handle_h nMasterHandle, uint8_t io_byte);

MAGRESWCH_API void DioSetupOLED(dio_handle_h nMasterHandle, int16_t* lpnStatus);
 

MAGRESWCH_API void DioWriteOLEDPixelPairImm(dio_handle_h nMasterHandle, uint8_t column, uint8_t y, uint8_t val);

MAGRESWCH_API void DioWriteOLEDPixelPairBuff(dio_handle_h nMasterHandle, dio_oled_write_mode_e mode,
    uint8_t column, uint8_t y, uint8_t val);

MAGRESWCH_API void DioWriteOLEDPixelImm(dio_handle_h nMasterHandle, uint8_t row, uint8_t column, uint8_t val);

MAGRESWCH_API void DioWriteOLEDPixelBuff(dio_handle_h nMasterHandle, dio_oled_write_mode_e mode,
    uint8_t x, uint8_t y, uint8_t val);

MAGRESWCH_API void DioWriteOLEDLineImm(dio_handle_h nMasterHandle,
    uint8_t x1,
    uint8_t y1,
    uint8_t x2,
    uint8_t y2,
    uint8_t val1,
    uint8_t val2);
 

MAGRESWCH_API void DioWriteOLEDLineBuff(dio_handle_h nMasterHandle,
    dio_oled_write_mode_e mode,
    uint8_t x1,
    uint8_t y1,
    uint8_t x2,
    uint8_t y2,
    uint8_t val1,
    uint8_t val2);

MAGRESWCH_API void DioWriteOLEDArrImm(dio_handle_h nMasterHandle, uint8_t x, uint8_t y, uint8_t *arr, size_t len);
 

MAGRESWCH_API void DioWriteOLEDArrBuff(dio_handle_h nMasterHandle, dio_oled_write_mode_e mode,
    uint8_t x, uint8_t y, uint8_t *arr, size_t len);

MAGRESWCH_API void DioWriteOLEDScreenArrImm(dio_handle_h nMasterHandle, uint8_t *arr);

MAGRESWCH_API void DioWriteOLEDScreenArrBuff(dio_handle_h nMasterHandle, dio_oled_write_mode_e
    mode, uint8_t *arr);
 

MAGRESWCH_API void DioWriteOLEDRowArrImm(dio_handle_h nMasterHandle, uint8_t y, uint8_t *arr);
 

MAGRESWCH_API void DioWriteOLEDRowArrBuff(dio_handle_h nMasterHandle, dio_oled_write_mode_e mode,
    uint8_t y, uint8_t *arr);

MAGRESWCH_API void DioWriteOLEDRowValImm(dio_handle_h nMasterHandle, uint8_t y, uint8_t val);

MAGRESWCH_API void DioWriteOLEDAreaArrImm(dio_handle_h nMasterHandle, uint8_t x, uint8_t y,
    uint8_t col_width, uint8_t height, uint8_t *arr);

MAGRESWCH_API void DioWriteOLEDAreaArrBuff(dio_handle_h nMasterHandle, dio_oled_write_mode_e
    mode, uint8_t x, uint8_t y,
    uint8_t col_width, uint8_t height,
    uint8_t *arr);

MAGRESWCH_API void DioWriteOLED2DUnpackedArrImm(dio_handle_h nMasterHandle, uint8_t **arr);

MAGRESWCH_API void DioSendOLEDBuff(dio_handle_h nMasterHandle);

MAGRESWCH_API void DioClearOLEDBuff(dio_handle_h nMasterHandle);

MAGRESWCH_API void DIOClearOLEDImm(dio_handle_h nMasterHandle);

MAGRESWCH_API dio_bmp_h DioOpenBMP(dio_handle_h nMasterHandle, char *path, int16_t *lpnStatus);
 

MAGRESWCH_API void DioCloseBMP(dio_handle_h nMasterHandle,
    dio_bmp_h *bmp_handle);
 

MAGRESWCH_API void DioWriteOLEDAreaBMPImm(dio_handle_h nMasterHandle, uint8_t x, uint8_t y,
    dio_bmp_h bmp_handle);

MAGRESWCH_API void DioWriteOLEDAreaBMPBuff(dio_handle_h nMasterHandle,
    dio_oled_write_mode_e mode, uint8_t x, uint8_t y, dio_bmp_h bmp_handle);

MAGRESWCH_API void DioWriteOLEDCharImm(dio_handle_h nMasterHandle, uint8_t x, uint8_t y, char letter);
 

MAGRESWCH_API void DioWriteOLEDCharBuff(dio_handle_h nMasterHandle,
    dio_oled_write_mode_e mode,
    uint8_t x, uint8_t y,
    char letter);
 

MAGRESWCH_API void DioWriteOLEDStrImm(dio_handle_h nMasterHandle,
    uint8_t x, uint8_t y,
    char* str);

MAGRESWCH_API void DioWriteOLEDStrBuff(dio_handle_h nMasterHandle,
    dio_oled_write_mode_e mode,
    uint8_t x, uint8_t y,
    char* str);

MAGRESWCH_API const char* DioGetErrorStr(dio_handle_h nMasterHandle, int16_t lpnStatus);
 
#ifdef __cplusplus
}
#endif