slcd.h

 
/*
 * MIT License
 *
 * Copyright (c) 2023 Joey Castillo
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
 
#pragma once
 
#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>
#include "system.h"
 
#ifdef SLCD
 
typedef enum {
    SLCD_BIAS_STATIC = 0,
    SLCD_BIAS_HALF = 1,
    SLCD_BIAS_THIRD = 2,
    SLCD_BIAS_FOURTH = 3,
} slcd_bias_value_t;
 
typedef enum {
    SLCD_DUTY_1_COMMON = 0,
    SLCD_DUTY_2_COMMON = 1,
    SLCD_DUTY_3_COMMON = 2,
    SLCD_DUTY_4_COMMON = 3,
    SLCD_DUTY_6_COMMON = 4,
    SLCD_DUTY_8_COMMON = 5,
} slcd_duty_value_t;
 
typedef enum {
    SLCD_PRESCALER_DIV16 = 0,
    SLCD_PRESCALER_DIV32 = 1,
    SLCD_PRESCALER_DIV64 = 2,
    SLCD_PRESCALER_DIV128 = 3,
} slcd_prescaler_value_t;
 
typedef enum {
    SLCD_CLOCKSOURCE_ULP = 0,
    SLCD_CLOCKSOURCE_XOSC = 1,
} slcd_clocksource_value_t;
 
typedef enum {
    SLCD_CLOCKDIV_1 = 0,
    SLCD_CLOCKDIV_2 = 1,
    SLCD_CLOCKDIV_3 = 2,
    SLCD_CLOCKDIV_4 = 3,
    SLCD_CLOCKDIV_5 = 4,
    SLCD_CLOCKDIV_6 = 5,
    SLCD_CLOCKDIV_7 = 6,
    SLCD_CLOCKDIV_8 = 7,
} slcd_clockdiv_value_t;
 
typedef enum {
    SLCD_CSRSHIFT_LEFT = 0,
    SLCD_CSRSHIFT_RIGHT = 1,
} slcd_csrshift_value_t;
 
void slcd_init(uint64_t lcd_pins, slcd_bias_value_t bias, slcd_duty_value_t duty, slcd_clocksource_value_t clocksource, slcd_prescaler_value_t prescaler, slcd_clockdiv_value_t clkdiv);
 
void slcd_set_contrast(uint8_t contrast);
 
void slcd_enable(void);
 
void slcd_clear(void);
 
void slcd_set_segment(uint8_t com, uint8_t seg);
 
void slcd_clear_segment(uint8_t com, uint8_t seg);
 
void slcd_configure_frame_counter(uint8_t fc, uint8_t overflow_count, bool prescale);
 
void slcd_set_frame_counter_enabled(uint8_t fc, bool enabled);
 
void slcd_configure_blink(bool blink_all, uint8_t bss0, uint8_t bss1, uint8_t fc);
 
void slcd_set_blink_enabled(bool enabled);
 
void slcd_configure_circular_shift_animation(uint16_t initial_value, uint8_t size, slcd_csrshift_value_t shift_dir, uint8_t fc);
 
void slcd_set_circular_shift_animation_enabled(bool enabled);
 
void slcd_disable(void);
 
 
#endif // SLCD