open-story-teller/software/system/ost_hal.h

#ifndef OST_HAL_H
#define OST_HAL_H

#ifdef __cplusplus
extern "C"
{
#endif

#include <stdint.h>

#define OST_ID_SPI_FOR_SDCARD 0

    // ----------------------------------------------------------------------------
    // SHARED TYPES
    // ----------------------------------------------------------------------------
    typedef struct
    {
        uint16_t x;
        uint16_t y;
        uint16_t width;
        uint16_t height;
    } rect_t;

    typedef struct
    {
        uint8_t r;
        uint8_t g;
        uint8_t b;
    } color_t;

    typedef enum
    {
        OST_GPIO_DEBUG_LED,
        OST_GPIO_DEBUG_PIN
    } ost_hal_gpio_t;

    typedef enum
    {
        OST_BUTTON_OK = 0x01,
        OST_BUTTON_HOME = 0x02,
        OST_BUTTON_PAUSE = 0x04,
        OST_BUTTON_VOLUME_UP = 0x08,
        OST_BUTTON_VOLUME_DOWN = 0x10,
        OST_BUTTON_LEFT = 0x20,
        OST_BUTTON_RIGHT = 0x40
    } ost_button_t;

    // ----------------------------------------------------------------------------
    // HIGH LEVEL API
    // ----------------------------------------------------------------------------
    // System API
    void ost_system_initialize();
    void system_putc(char ch);
    void ost_system_delay_ms(uint32_t delay);
    void ost_system_stopwatch_start();
    uint32_t ost_system_stopwatch_stop();

    // Audio API
    void ost_audio_play(const char *filename);
    void ost_audio_stop();
    int ost_audio_process();
    typedef void (*ost_audio_callback_t)(void);
    void ost_audio_register_callback(ost_audio_callback_t cb);

    // Buttons APU
    typedef void (*ost_button_callback_t)(uint32_t flags);
    void ost_button_register_callback(ost_button_callback_t cb);

    // ----------------------------------------------------------------------------
    // GPIO HAL
    // ----------------------------------------------------------------------------

    int ost_hal_gpio_get(ost_hal_gpio_t gpio);
    void ost_hal_gpio_set(ost_hal_gpio_t gpio, int value);

    // ----------------------------------------------------------------------------
    // SDCARD HAL
    // ----------------------------------------------------------------------------

    void ost_hal_sdcard_set_slow_clock(void);
    void ost_hal_sdcard_set_fast_clock(void);

    /**
     * @brief Deselect the SD-Card by driving the Chip Select to high level (eg: 3.3V)
     *
     */
    void ost_hal_sdcard_cs_high();

    /**
     * @brief Deselect the SD-Card by driving the Chip Select to low level (eg: 0V)
     *
     */
    void ost_hal_sdcard_cs_low();

    // We have a separated API here to allow specific optimizations such as the use of DMA

    void ost_hal_sdcard_spi_exchange(const uint8_t *buffer, uint8_t *out, uint32_t size);

    void ost_hal_sdcard_spi_write(const uint8_t *buffer, uint32_t size);

    void ost_hal_sdcard_spi_read(uint8_t *out, uint32_t size);

    /**
     * @brief Return 1 if the SD card is physically inserted, otherwise 0
     *
     * @return uint8_t SD card is present or not
     */
    uint8_t ost_hal_sdcard_get_presence();

    // ----------------------------------------------------------------------------
    // DISPLAY HAL
    // ----------------------------------------------------------------------------
    void ost_display_initialize();
    void ost_display_draw_h_line(uint16_t y, uint8_t *pixels, uint8_t *palette);
    void ost_display_dc_high();
    void ost_display_dc_low();
    void ost_display_ss_high();
    void ost_display_ss_low();
    uint8_t ost_display_transfer_byte(uint8_t dat);
    void ost_display_transfer_multi(uint8_t *buff, uint32_t btr);
    void ost_display_draw_h_line_rgb888(uint16_t y, const color_t *data);

    // ----------------------------------------------------------------------------
    // AUDIO HAL
    // ----------------------------------------------------------------------------
    void ost_hal_audio_new_frame(const void *buffer, int size);

#ifdef __cplusplus
}
#endif

#endif // OST_HAL_H