hx711_multi.h

Go to the documentation of this file.

// MIT License
// 
// Copyright (c) 2023 Daniel Robertson
// 
// 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.
 
#ifndef HX711_MULTI_H_253BF37A_8356_462B_B8F9_39E09A7193E6
#define HX711_MULTI_H_253BF37A_8356_462B_B8F9_39E09A7193E6
 
#include <stdint.h>
#include <strings.h>
#include "hardware/pio.h"
#include "pico/mutex.h"
#include "pico/platform.h"
#include "hx711.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define HX711_MULTI_CONVERSION_DONE_IRQ_NUM     UINT8_C(0)
 
#define HX711_MULTI_DATA_READY_IRQ_NUM          UINT8_C(4)
 
#define HX711_MULTI_ASYNC_READ_COUNT            UINT8_C(NUM_PIOS)
 
#define HX711_MULTI_ASYNC_PIO_IRQ_IDX           UINT8_C(0)
#define HX711_MULTI_ASYNC_DMA_IRQ_IDX           UINT8_C(0)
 
#define HX711_MULTI_MIN_CHIPS                   UINT8_C(1)
 
#define HX711_MULTI_MAX_CHIPS                   UINT8_C(MIN(NUM_BANK0_GPIOS, 32))
 
typedef enum {
    HX711_MULTI_ASYNC_STATE_NONE = 0,
    HX711_MULTI_ASYNC_STATE_WAITING,
    HX711_MULTI_ASYNC_STATE_READING,
    HX711_MULTI_ASYNC_STATE_DONE
} hx711_multi_async_state_t;
 
typedef struct {
 
    uint _clock_pin;
    uint _data_pin_base;
    size_t _chips_len;
 
    PIO _pio;
 
    const pio_program_t* _awaiter_prog;
    pio_sm_config _awaiter_default_config;
    uint _awaiter_sm;
    uint _awaiter_offset;
 
    const pio_program_t* _reader_prog;
    pio_sm_config _reader_default_config;
    uint _reader_sm;
    uint _reader_offset;
 
    uint _dma_channel;
 
    uint32_t _buffer[HX711_READ_BITS];
 
    uint _pio_irq_index;
    uint _dma_irq_index;
    volatile hx711_multi_async_state_t _async_state;
 
#ifndef HX711_NO_MUTEX
    mutex_t _mut;
#endif
 
} hx711_multi_t;
 
typedef void (*hx711_multi_pio_init_t)(hx711_multi_t* const);
typedef void (*hx711_multi_program_init_t)(hx711_multi_t* const);
 
typedef struct {
 
    uint clock_pin;
 
    uint data_pin_base;
 
    size_t chips_len;
 
 
    uint pio_irq_index;
 
    uint dma_irq_index;
 
 
    PIO pio;
 
    hx711_multi_pio_init_t pio_init;
 
 
    const pio_program_t* awaiter_prog;
 
    hx711_multi_program_init_t awaiter_prog_init;
 
 
    const pio_program_t* reader_prog;
 
    hx711_multi_program_init_t reader_prog_init;
 
} hx711_multi_config_t;
 
extern hx711_multi_t* hx711_multi__async_read_array[
    HX711_MULTI_ASYNC_READ_COUNT];
 
static void hx711_multi__init_asert(
    const hx711_multi_config_t* const config);
 
static void hx711_multi__init_pio(hx711_multi_t* const hxm);
 
static void hx711_multi__init_dma(hx711_multi_t* const hxm);
 
static void hx711_multi__init_irq(hx711_multi_t* const hxm);
 
static bool hx711_multi__async_dma_irq_is_set(
    hx711_multi_t* const hxm);
 
static bool hx711_multi__async_pio_irq_is_set(
    hx711_multi_t* const hxm);
 
static hx711_multi_t* const hx711_multi__async_get_dma_irq_request();
 
static hx711_multi_t* const hx711_multi__async_get_pio_irq_request();
 
static void hx711_multi__async_start_dma(
    hx711_multi_t* const hxm);
 
static bool hx711_multi__async_is_running(
    hx711_multi_t* const hxm);
 
static void hx711_multi__async_finish(
    hx711_multi_t* const hxm);
 
static void __isr __not_in_flash_func(hx711_multi__async_pio_irq_handler)();
 
static void __isr __not_in_flash_func(hx711_multi__async_dma_irq_handler)();
 
static bool hx711_multi__async_add_reader(
    hx711_multi_t* const hxm);
 
static void hx711_multi__async_remove_reader(
    const hx711_multi_t* const hxm);
 
static bool hx711_multi__is_initd(hx711_multi_t* const hxm);
 
static bool hx711_multi__is_state_machines_enabled(
    hx711_multi_t* const hxm);
 
void hx711_multi_pinvals_to_values(
    const uint32_t* const pinvals,
    int32_t* const values,
    const size_t len);
 
void hx711_multi_init(
    hx711_multi_t* const hxm,
    const hx711_multi_config_t* const config);
 
void hx711_multi_close(hx711_multi_t* const hxm);
 
void hx711_multi_set_gain(
    hx711_multi_t* const hxm,
    const hx711_gain_t gain);
 
void hx711_multi_get_values(
    hx711_multi_t* const hxm,
    int32_t* const values);
 
bool hx711_multi_get_values_timeout(
    hx711_multi_t* const hxm,
    int32_t* const values,
    const uint timeout);
 
void hx711_multi_async_start(hx711_multi_t* const hxm);
 
bool hx711_multi_async_done(hx711_multi_t* const hxm);
 
void hx711_multi_async_get_values(
    hx711_multi_t* const hxm,
    int32_t* const values);
 
void hx711_multi_power_up(
    hx711_multi_t* const hxm,
    const hx711_gain_t gain);
 
void hx711_multi_power_down(hx711_multi_t* const hxm);
 
void hx711_multi_sync(
    hx711_multi_t* const hxm,
    const hx711_gain_t gain);
 
uint32_t hx711_multi_get_sync_state(
    hx711_multi_t* const hxm);
 
bool hx711_multi_is_syncd(
    hx711_multi_t* const hxm);
 
#ifdef __cplusplus
}
#endif
 
#endif