MAX22200 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
max22200_registers.hpp
Go to the documentation of this file.
1
17#ifndef MAX22200_REGISTERS_HPP
18#define MAX22200_REGISTERS_HPP
19
20#include <cstddef>
21#include <cstdint>
22
23#include "max22200_detail.hpp"
24
26namespace max22200::reg {
27
28using detail::operator""_u8;
29
36// --- Register banks (A_BNK, Register Map) --------------------------------------------------------
37inline constexpr uint8_t kStatus = 0x00;
38inline constexpr uint8_t kCfgCh0 = 0x01;
39inline constexpr uint8_t kFault = 0x09;
40inline constexpr uint8_t kCfgDpm = 0x0A;
41
47constexpr uint8_t CfgChannel(uint8_t channel) noexcept {
48 return static_cast<uint8_t>(static_cast<uint32_t>(kCfgCh0) +
49 (static_cast<uint32_t>(channel) & 0x07U));
50}
51
52// --- Command Register (Table 9) ------------------------------------------------------------------
53inline constexpr uint8_t kCmdWrite = 0x80;
54inline constexpr uint8_t kCmdBankShift = 1;
55inline constexpr uint8_t kCmdBankMask = 0x0F;
56inline constexpr uint8_t kCmd8Bit = 0x01;
57
65constexpr uint8_t Command(uint8_t bank, bool write, bool eight_bit) noexcept {
66 return static_cast<uint8_t>((write ? static_cast<uint32_t>(kCmdWrite) : 0U) |
67 ((static_cast<uint32_t>(bank) & kCmdBankMask) << kCmdBankShift) |
68 (eight_bit ? static_cast<uint32_t>(kCmd8Bit) : 0U));
69}
70
71// --- STATUS (0x00), Table 10 and Register Details ------------------------------------------------
72inline constexpr uint32_t kOnchShift = 24;
73inline constexpr uint32_t kMaskOvt = uint32_t{1} << 23U;
74inline constexpr uint32_t kMaskOcp = uint32_t{1} << 22U;
75inline constexpr uint32_t kMaskOlf = uint32_t{1} << 21U;
76inline constexpr uint32_t kMaskHhf = uint32_t{1} << 20U;
77inline constexpr uint32_t kMaskDpm = uint32_t{1} << 19U;
78inline constexpr uint32_t kMaskComf = uint32_t{1} << 18U;
79inline constexpr uint32_t kMaskUvm = uint32_t{1} << 17U;
80inline constexpr uint32_t kFreqm = uint32_t{1}
81 << 16U;
82inline constexpr uint32_t kPairModeShift = 8;
84inline constexpr uint32_t kOvt = uint32_t{1} << 7U;
85inline constexpr uint32_t kOcp = uint32_t{1}
86 << 6U;
87inline constexpr uint32_t kOlf = uint32_t{1}
88 << 5U;
89inline constexpr uint32_t kHhf = uint32_t{1}
90 << 4U;
91inline constexpr uint32_t kDpm = uint32_t{1}
92 << 3U;
93inline constexpr uint32_t kComer = uint32_t{1}
94 << 2U;
95inline constexpr uint32_t kUvm = uint32_t{1} << 1U;
97inline constexpr uint32_t kActive = uint32_t{1}
98 << 0U;
99inline constexpr uint32_t kFlagsMask = 0xFEU;
100inline constexpr uint32_t kWritableMask = 0xFFFFFF01U;
101inline constexpr uint32_t kStatusReset = kMaskComf | kUvm;
102
108constexpr uint32_t PairModeShift(uint8_t pair) noexcept {
109 return kPairModeShift + (2U * (static_cast<uint32_t>(pair) & 0x03U));
110}
111
112// --- CFG_CHn (0x01 to 0x08), Table 11 and Register Details ---------------------------------------
113inline constexpr uint32_t kHfs = uint32_t{1}
114 << 31U;
115inline constexpr uint32_t kHoldShift = 24;
116inline constexpr uint32_t kTrgnspi = uint32_t{1}
117 << 23U;
118inline constexpr uint32_t kHitShift = 16;
119inline constexpr uint32_t kHitTimeShift = 8;
120inline constexpr uint32_t kVdrncdr = uint32_t{1}
121 << 7U;
122inline constexpr uint32_t kHsnls = uint32_t{1} << 6U;
123inline constexpr uint32_t kFreqCfgShift = 4;
124inline constexpr uint32_t kSrc = uint32_t{1} << 3U;
125inline constexpr uint32_t kOlEn = uint32_t{1} << 2U;
126inline constexpr uint32_t kDpmEn = uint32_t{1} << 1U;
127inline constexpr uint32_t kHhfEn = uint32_t{1} << 0U;
128inline constexpr uint32_t kCodeMask = 0x7FU;
129inline constexpr uint8_t kHfsByte = 0x80;
130
131// --- FAULT (0x09), Table 12 ----------------------------------------------------------------------
132inline constexpr uint32_t kFaultOcpShift = 24;
133inline constexpr uint32_t kFaultHhfShift = 16;
134inline constexpr uint32_t kFaultOlfShift = 8;
135inline constexpr uint32_t kFaultDpmShift = 0;
136
141inline constexpr bool kFaultClearLsbByteFirst = true;
142
148constexpr uint32_t FaultClearSdi(uint32_t mask) noexcept {
149 if constexpr (kFaultClearLsbByteFirst) {
150 return mask;
151 } else {
152 return ((mask & 0xFFU) << 24U) | ((mask & 0xFF00U) << 8U) | ((mask >> 8U) & 0xFF00U) |
153 (mask >> 24U);
154 }
155}
156
157// --- CFG_DPM (0x0A), "Detection of Plunger Movement Register Description" ------------------------
158inline constexpr uint32_t kDpmIstartShift = 8;
159inline constexpr uint32_t kDpmIstartMask = 0x7FU;
160inline constexpr uint32_t kDpmTdebShift = 4;
161inline constexpr uint32_t kDpmTdebMask = 0x0FU;
162inline constexpr uint32_t kDpmIpthShift = 0;
163inline constexpr uint32_t kDpmIpthMask = 0x0FU;
164inline constexpr uint32_t kDpmUsedMask = 0x7FFFU;
165
166// --- Timing (Electrical Characteristics) ---------------------------------------------------------
167inline constexpr uint32_t kEnableUs = 500;
168inline constexpr uint32_t kWakeUpUs = 2500;
169inline constexpr uint32_t kDisableUs = 2500;
170// The SPI bus requirements (mode, clock, CSB and CMD timing) are in max22200_spi_interface.hpp.
171
172// --- Layout checks (handbook: register layouts asserted) -----------------------------------------
173static_assert(Command(kStatus, false, false) == 0x00U, "Table 9: read STATUS, 32 bits");
174static_assert(Command(kCfgDpm, true, false) == 0x94U, "Table 9: A_BNK at bits 4:1, RB/W at bit 7");
175static_assert(Command(kStatus, true, true) == 0x81U, "Table 9: 8bit/n32bits at bit 0");
176static_assert(CfgChannel(7_u8) == 0x08U, "Register Map: CFG_CH7 at 0x08");
177static_assert(kStatusReset == 0x00040002U, "Register Details: M_COMF = 1, UVM = 1 at reset");
178static_assert((kWritableMask & kFlagsMask) == 0U, "the flags are read only");
179static_assert(PairModeShift(3_u8) == 14U, "Register Details: CM76 at bits 15:14");
180
183} // namespace max22200::reg
184
185#endif // MAX22200_REGISTERS_HPP
constexpr uint32_t kFaultOcpShift
OCP[7:0]; channel 0 is the LSB of each byte.
Definition max22200_registers.hpp:132
constexpr uint32_t kOlEn
OL_EN: open-load detection.
Definition max22200_registers.hpp:125
constexpr uint32_t kPairModeShift
Definition max22200_registers.hpp:82
constexpr uint32_t kMaskOlf
M_OLF.
Definition max22200_registers.hpp:75
constexpr uint32_t kHoldShift
HOLD[6:0] at bits 30:24.
Definition max22200_registers.hpp:115
constexpr uint8_t kCmdBankShift
A_BNK is bits 4:1; bits 6:5 (RFU) stay 0.
Definition max22200_registers.hpp:54
constexpr uint8_t kCmdBankMask
A_BNK width.
Definition max22200_registers.hpp:55
constexpr uint32_t kDpmEn
DPM_EN: plunger-movement detection.
Definition max22200_registers.hpp:126
constexpr uint32_t kHhf
HHF flag: some channel has an HHF bit in FAULT.
Definition max22200_registers.hpp:89
constexpr uint32_t kHfs
HFS: half full-scale (KFS 7.5k instead of 15k).
Definition max22200_registers.hpp:113
constexpr uint32_t kTrgnspi
TRGnSPI: the TRIGA/TRIGB pin switches it.
Definition max22200_registers.hpp:116
constexpr uint32_t kMaskOvt
M_OVT: OVT does not assert FAULT.
Definition max22200_registers.hpp:73
constexpr uint8_t kCmdWrite
RB/W = 1: the next transfer writes.
Definition max22200_registers.hpp:53
constexpr uint32_t kStatusReset
0x00040002 after power-up.
Definition max22200_registers.hpp:101
constexpr uint32_t kFlagsMask
The seven read-only flags, bits 7:1.
Definition max22200_registers.hpp:99
constexpr uint32_t kDpm
DPM flag: some channel has a DPM bit in FAULT.
Definition max22200_registers.hpp:91
constexpr uint8_t Command(uint8_t bank, bool write, bool eight_bit) noexcept
The Command Register byte for one access.
Definition max22200_registers.hpp:65
constexpr uint32_t kFaultDpmShift
DPM[7:0].
Definition max22200_registers.hpp:135
constexpr uint32_t kOnchShift
ONCH[7:0]: bit 24 + n switches channel n on.
Definition max22200_registers.hpp:72
constexpr uint32_t kHitTimeShift
HIT_T[7:0] at bits 15:8.
Definition max22200_registers.hpp:119
constexpr uint32_t kDpmIpthMask
DPM_IPTH width.
Definition max22200_registers.hpp:163
constexpr uint32_t kOvt
OVT flag; a STATUS read clears it.
Definition max22200_registers.hpp:84
constexpr uint32_t PairModeShift(uint8_t pair) noexcept
Shift of a channel pair's CMxy field in STATUS.
Definition max22200_registers.hpp:108
constexpr uint32_t kVdrncdr
VDRnCDR: 1 = voltage drive, 0 = current drive.
Definition max22200_registers.hpp:120
constexpr uint32_t kWritableMask
Every bit a write sets.
Definition max22200_registers.hpp:100
constexpr uint32_t kDpmIstartMask
DPM_ISTART width.
Definition max22200_registers.hpp:159
constexpr uint32_t kHitShift
HIT[6:0] at bits 22:16.
Definition max22200_registers.hpp:118
constexpr uint8_t kStatus
STATUS: ONCH, fault masks, FREQM, CMxy, flags, ACTIVE.
Definition max22200_registers.hpp:37
constexpr uint32_t kDisableUs
tDIS max: ENABLE falling edge to outputs Hi-Z.
Definition max22200_registers.hpp:169
constexpr uint32_t kSrc
SRC: slew-rate controlled edges.
Definition max22200_registers.hpp:124
constexpr uint32_t kDpmUsedMask
Bits 31:15 "must be set at zero".
Definition max22200_registers.hpp:164
constexpr uint32_t FaultClearSdi(uint32_t mask) noexcept
The register-aligned clear mask as SDI must carry it, for kFaultClearLsbByteFirst.
Definition max22200_registers.hpp:148
constexpr uint32_t kComer
COMER: a write had the wrong number of clocks.
Definition max22200_registers.hpp:93
constexpr uint8_t kCfgCh0
CFG_CH0; CFG_CHn is at 0x01 + n, up to 0x08.
Definition max22200_registers.hpp:38
constexpr uint32_t kDpmIpthShift
DPM_IPTH[3:0] at bits 3:0.
Definition max22200_registers.hpp:162
constexpr uint32_t kActive
ACTIVE: 0 = low-power, channels Hi-Z (reset).
Definition max22200_registers.hpp:97
constexpr uint32_t kHhfEn
HHF_EN: HIT-current check.
Definition max22200_registers.hpp:127
constexpr uint32_t kEnableUs
tEN max: ENABLE rising edge to SPI ready.
Definition max22200_registers.hpp:167
constexpr uint32_t kDpmTdebShift
DPM_TDEB[3:0] at bits 7:4.
Definition max22200_registers.hpp:160
constexpr uint8_t kCfgDpm
CFG_DPM: the plunger-movement detection settings.
Definition max22200_registers.hpp:40
constexpr uint32_t kMaskUvm
M_UVM.
Definition max22200_registers.hpp:79
constexpr uint32_t kMaskOcp
M_OCP.
Definition max22200_registers.hpp:74
constexpr uint32_t kFreqm
FREQM: 0 = 100 kHz, 1 = 80 kHz oscillator.
Definition max22200_registers.hpp:80
constexpr uint32_t kDpmIstartShift
DPM_ISTART[6:0] at bits 14:8.
Definition max22200_registers.hpp:158
constexpr bool kFaultClearLsbByteFirst
Definition max22200_registers.hpp:141
constexpr uint32_t kOlf
OLF flag: some channel has an OLF bit in FAULT.
Definition max22200_registers.hpp:87
constexpr uint32_t kFaultHhfShift
HHF[7:0].
Definition max22200_registers.hpp:133
constexpr uint32_t kMaskComf
M_COMF; 1 at reset (COMER masked).
Definition max22200_registers.hpp:78
constexpr uint32_t kDpmTdebMask
DPM_TDEB width.
Definition max22200_registers.hpp:161
constexpr uint8_t kFault
FAULT (read only): OCP, HHF, OLF, DPM per channel.
Definition max22200_registers.hpp:39
constexpr uint8_t kHfsByte
HFS in the 8-bit (bits 31:24) access.
Definition max22200_registers.hpp:129
constexpr uint32_t kFreqCfgShift
FREQ_CFG[1:0] at bits 5:4.
Definition max22200_registers.hpp:123
constexpr uint32_t kWakeUpUs
tWU max: ACTIVE = 1 to outputs active.
Definition max22200_registers.hpp:168
constexpr uint32_t kOcp
OCP flag: some channel has an OCP bit in FAULT.
Definition max22200_registers.hpp:85
constexpr uint32_t kMaskDpm
M_DPM.
Definition max22200_registers.hpp:77
constexpr uint32_t kUvm
Definition max22200_registers.hpp:95
constexpr uint8_t CfgChannel(uint8_t channel) noexcept
The bank of a channel's configuration register.
Definition max22200_registers.hpp:47
constexpr uint32_t kFaultOlfShift
OLF[7:0].
Definition max22200_registers.hpp:134
constexpr uint32_t kCodeMask
Width of HIT and HOLD.
Definition max22200_registers.hpp:128
constexpr uint8_t kCmd8Bit
8bit/n32bits = 1: the next transfer is bits 31:24.
Definition max22200_registers.hpp:56
constexpr uint32_t kHsnls
HSnLS: 1 = high side (VDR only).
Definition max22200_registers.hpp:122
constexpr uint32_t kMaskHhf
M_HHF.
Definition max22200_registers.hpp:76
Compile-time helpers of the MAX22200 driver: exact hook matching, typed register fields and enumerati...
The MAX22200 register map.
Definition max22200_registers.hpp:26