sx1509b.hpp

Go to the documentation of this file.

/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright 2018-2019 Peter A. Bigot */
 
#ifndef NRFCXX_MISC_SX1509B_HPP
#define NRFCXX_MISC_SX1509B_HPP
#pragma once
 
#include <nrfcxx/periph.hpp>
#include <nrfcxx/gpio.hpp>
 
namespace nrfcxx {
namespace misc {
 
class sx1509b
{
public:
  struct iface_config_type
  {
    periph::TWI& twi;
 
    int8_t resetn_psel = -1;
 
    uint8_t address;
 
    iface_config_type (const iface_config_type&) = delete;
    iface_config_type& operator= (const iface_config_type&) = delete;
    iface_config_type (iface_config_type&&) = delete;
    iface_config_type& operator= (iface_config_type&&) = delete;
  };
 
  const iface_config_type& iface_config () const
  {
    return iface_config_;
  }
 
  struct gpio_regs_type
  {
    uint16_t input_disable = 0U;     // 0x00
    uint16_t long_slew = 0U;         // 0x02
    uint16_t low_drive = 0U;         // 0x04
    uint16_t pull_up = 0U;           // 0x06
    uint16_t pull_down = 0U;         // 0x08
    uint16_t open_drain = 0U;        // 0x0A
    uint16_t polarity = 0U;          // 0x0C
    uint16_t dir = -1;               // 0x0E
    uint16_t data = -1;              // 0x10
    // Subsequent registers deal with input, which is not supported on
    // the Thingy:52 nor currently via this driver.
  };
 
  const gpio_regs_type& gpio_cache () const noexcept
  {
    return gpio_cache_;
  }
 
  uint16_t led_driver_cache () const
  {
    return led_driver_cache_;
  }
 
  uint8_t clock_cache () const
  {
    return clock_cache_;
  }
 
  uint8_t misc_cache () const
  {
    return misc_cache_;
  }
 
  int reload_cache () noexcept;
 
  unsigned int configuration (unsigned int psel) const noexcept;
 
  int configure (unsigned int psel,
                 unsigned int pin_cnf,
                 int initial = -1) noexcept;
 
  int multiconfigure (uint16_t out_set,
                      uint16_t out_clear,
                      uint16_t pull_down,
                      uint16_t pull_up = 0) noexcept;
 
  struct led_type
  {
    uint8_t ton = 0;
 
    uint8_t ion = -1;
 
    uint8_t off = 0;
  };
 
  struct led_pwm_type : public led_type
  {
    uint8_t trise = 0;
 
    uint8_t tfall = 0;
  };
 
  static constexpr auto RegClock_FREQ_Pos = 5U;
  static constexpr uint16_t RegClock_FREQ_Msk = 0x03 << RegClock_FREQ_Pos;
  static constexpr uint16_t RegClock_FREQ_Off = 0;
  static constexpr uint16_t RegClock_FREQ_External = 1;
  static constexpr uint16_t RegClock_FREQ_2MHz = 2;
 
  static constexpr auto RegClock_OSCIO_Pos = 4U;
  static constexpr uint16_t RegClock_OSCIO_Msk = 0x01 << RegClock_OSCIO_Pos;
  static constexpr uint16_t RegClock_OSCIO_Input = 0;
  static constexpr uint16_t RegClock_OSCIO_Output = 1;
 
  static constexpr auto RegClock_OUTFREQ_Pos = 0U;
  static constexpr uint16_t RegClock_OUTFREQ_Msk = 0x0F << RegClock_OUTFREQ_Pos;
  static constexpr uint16_t RegClock_OUTFREQ_Low = 0;
  static constexpr uint16_t RegClock_OUTFREQ_High = 0x0F;
 
  static constexpr auto RegMisc_LEDB_Pos = 7U;
  static constexpr uint16_t RegMisc_LEDB_Msk = 1U << RegMisc_LEDB_Pos;
  static constexpr uint16_t RegMisc_LEDB_Linear = 0;
  static constexpr uint16_t RegMisc_LEDB_Logarithmic = 1;
 
  static constexpr auto RegMisc_LEDFREQ_Pos = 4U;
  static constexpr uint16_t RegMisc_LEDFREQ_Msk = 0x07U << RegMisc_LEDFREQ_Pos;
  static constexpr uint16_t RegMisc_LEDFREQ_Off = 0;
 
  static constexpr auto RegMisc_LEDA_Pos = 3U;
  static constexpr uint16_t RegMisc_LEDA_Msk = 1U << RegMisc_LEDA_Pos;
  static constexpr uint16_t RegMisc_LEDA_Linear = 0;
  static constexpr uint16_t RegMisc_LEDA_Logarithmic = 1;
 
  static constexpr auto RegMisc_NRESET_Pos = 2U;
  static constexpr uint16_t RegMisc_NRESET_Msk = 1U << RegMisc_NRESET_Pos;
  static constexpr uint16_t RegMisc_NRESET_POR = 0;
  static constexpr uint16_t RegMisc_NRESET_ResetCounters = 1;
 
  static constexpr auto RegMisc_AUTOINC_Pos = 1U;
  static constexpr uint16_t RegMisc_AUTOINC_Msk = 1U << RegMisc_AUTOINC_Pos;
  static constexpr uint16_t RegMisc_AUTOINC_On = 0;
  static constexpr uint16_t RegMisc_AUTOINC_Off = 1;
 
  static constexpr auto RegMisc_AUTOCLR_Pos = 0U;
  static constexpr uint16_t RegMisc_AUTOCLR_Msk = 1U << RegMisc_AUTOCLR_Pos;
  static constexpr uint16_t RegMisc_AUTOCLR_On = 0;
  static constexpr uint16_t RegMisc_AUTOCLR_Off = 1;
 
  static constexpr auto RegTOnX_TOn_Pos = 0U;
  static constexpr uint16_t RegTOnX_TOn_Msk = 0x1F << RegTOnX_TOn_Pos;
  static constexpr auto RegOffX_TOff_Pos = 3U;
  static constexpr uint16_t RegOffX_TOff_Msk = 0x1F << RegOffX_TOff_Pos;
  static constexpr auto RegOffX_IOff_Pos = 0U;
  static constexpr uint16_t RegOffX_IOff_Msk = 0x07 << RegOffX_IOff_Pos;
 
  sx1509b (iface_config_type& ifc,
           unsigned int addr = 0) noexcept;
 
  int hw_reset () noexcept;
 
  int sw_reset () noexcept;
 
  int clock () const noexcept;
 
  int clock (uint8_t value) noexcept;
 
  int misc () const noexcept;
 
  int misc (uint8_t value) noexcept;
 
  int configure_as_leds (uint16_t leds,
                         bool source_current = false) noexcept;
 
  int led_configuration (unsigned int psel,
                         led_type& cfg) const noexcept;
 
  int led_configuration (unsigned int psel,
                         led_pwm_type& cfg) const noexcept;
 
  int led_configure (unsigned int psel,
                     const led_type& cfg) const noexcept;
 
  int led_configure (unsigned int psel,
                     const led_pwm_type& cfg) const noexcept;
 
  int output_sct (uint16_t set,
                  uint16_t clear) noexcept;
 
private:
  void reset_cache_ () noexcept;
 
  iface_config_type& iface_config_;
  gpio::pin_reference resetn_;
  gpio_regs_type gpio_cache_{};
  uint16_t led_driver_cache_ = 0;
  uint8_t clock_cache_ = 0;
  uint8_t misc_cache_ = 0;
};
 
} // ns misc
} // namespace
#endif /* NRFCXX_MISC_SX1509B_HPP */