ADS7952 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
ads7952_registers.hpp
Go to the documentation of this file.
1
18#ifndef ADS7952_REGISTERS_HPP
19#define ADS7952_REGISTERS_HPP
20
21#include <cstdint>
22
23#include "ads7952_detail.hpp"
24
26namespace ads7952::reg {
27
34// --- DI15:12, what the word is (Tables 1, 2, 3, 5, 6, 7, 11, 13) --------------------------------
35inline constexpr uint32_t kCommandShift = 12;
36inline constexpr uint16_t kCommandMask = 0xF000U;
37inline constexpr uint16_t kContinue = 0x0000U;
38inline constexpr uint16_t kManual = 0x1000U;
39inline constexpr uint16_t kAuto1 = 0x2000U;
40inline constexpr uint16_t kAuto2 = 0x3000U;
41inline constexpr uint16_t kGpioProgram = 0x4000U;
42inline constexpr uint16_t kAuto1Program = 0x8000U;
43inline constexpr uint16_t kAuto2Program = 0x9000U;
44inline constexpr uint16_t kAlarmProgramGroup0 = 0xC000U;
45
46// --- Mode control word, DI11:00 (Tables 1, 2, 5) -------------------------------------------------
47inline constexpr uint16_t kProgramEnable = 0x0800U;
48inline constexpr uint16_t kAutoReset = 0x0400U;
49inline constexpr uint32_t kManualChannelShift = 7;
50inline constexpr uint16_t kRangeTwoVref = 0x0040U;
51inline constexpr uint16_t kPowerDown = 0x0020U;
52inline constexpr uint16_t kGpioReadout = 0x0010U;
53inline constexpr uint16_t kGpioDataMask = 0x000FU;
54inline constexpr uint16_t kControlMask = 0x007FU;
55
56// --- Auto-2 program register (Table 6) -----------------------------------------------------------
57inline constexpr uint32_t kAuto2LastShift = 6;
58
59// --- GPIO program register (Table 11) ------------------------------------------------------------
60inline constexpr uint16_t kGpioResetAll = 0x0200U;
61inline constexpr uint16_t kGpio3PowerDown = 0x0100U;
62inline constexpr uint16_t kGpio2Range = 0x0080U;
63inline constexpr uint32_t kGpioAlarmShift = 4;
64inline constexpr uint16_t kGpioDirectionMask = 0x000FU;
65
66// --- Alarm program register, frame 2 onwards (Table 13) ------------------------------------------
67inline constexpr uint32_t kAlarmChannelShift = 14;
68inline constexpr uint16_t kAlarmHigh = 0x2000U;
69inline constexpr uint16_t kAlarmExit = 0x1000U;
70inline constexpr uint16_t kAlarmThresholdMask = 0x03FFU;
71inline constexpr uint16_t kAlarmHighReset = 0x03FFU;
72inline constexpr uint16_t kAlarmLowReset = 0x0000U;
73inline constexpr uint32_t kChannelsPerAlarmGroup = 4;
74
75// --- Reply word (section 8.1, Figure 2) ----------------------------------------------------------
76inline constexpr uint32_t kReplyAddressShift = 12;
77inline constexpr uint16_t kReplyCodeMask =
78 0x0FFFU;
79
80// --- Frame builders ------------------------------------------------------------------------------
81// Every operand is widened to uint32_t before a shift or a bitwise operator, and every shift count
82// is a constant below 16 (handbook KB-CPP20-020, -021; MISRA C++:2023 Rules 7.0.4, 7.0.5).
83
90[[nodiscard]] constexpr uint8_t ReplyAddress(uint16_t reply) noexcept {
91 return static_cast<uint8_t>((static_cast<uint32_t>(reply) >> kReplyAddressShift) & 0x0FU);
92}
93
99[[nodiscard]] constexpr uint16_t ReplyCode(uint16_t reply) noexcept {
100 return static_cast<uint16_t>(static_cast<uint32_t>(reply) & kReplyCodeMask);
101}
102
109[[nodiscard]] constexpr uint16_t ManualWord(uint8_t channel, uint16_t control) noexcept {
110 return static_cast<uint16_t>(static_cast<uint32_t>(kManual) | kProgramEnable |
111 ((static_cast<uint32_t>(channel) & 0x0FU) << kManualChannelShift) |
112 (static_cast<uint32_t>(control) & kControlMask));
113}
114
122[[nodiscard]] constexpr uint16_t AutoWord(uint16_t mode, bool restart, uint16_t control) noexcept {
123 return static_cast<uint16_t>((static_cast<uint32_t>(mode) & kCommandMask) | kProgramEnable |
124 (restart ? static_cast<uint32_t>(kAutoReset) : 0U) |
125 (static_cast<uint32_t>(control) & kControlMask));
126}
127
133[[nodiscard]] constexpr uint16_t Auto2ProgramWord(uint8_t last) noexcept {
134 return static_cast<uint16_t>(static_cast<uint32_t>(kAuto2Program) |
135 ((static_cast<uint32_t>(last) & 0x0FU) << kAuto2LastShift));
136}
137
143[[nodiscard]] constexpr uint16_t AlarmGroupWord(uint8_t group) noexcept {
144 return static_cast<uint16_t>(static_cast<uint32_t>(kAlarmProgramGroup0) |
145 ((static_cast<uint32_t>(group) & 0x03U) << kCommandShift));
146}
147
156[[nodiscard]] constexpr uint16_t AlarmThresholdWord(uint8_t channel_in_group, bool high, bool exit,
157 uint16_t threshold) noexcept {
158 return static_cast<uint16_t>(
159 ((static_cast<uint32_t>(channel_in_group) & 0x03U) << kAlarmChannelShift) |
160 (high ? static_cast<uint32_t>(kAlarmHigh) : 0U) |
161 (exit ? static_cast<uint32_t>(kAlarmExit) : 0U) |
162 (static_cast<uint32_t>(threshold) & kAlarmThresholdMask));
163}
164
165// The builders against the bit tables of the datasheet (KB-CPP20-012): a field in the wrong place
166// fails the build. Each argument has the parameter's type (MISRA C++:2023 Rule 7.0.6).
167using detail::operator""_u8;
168using detail::operator""_u16;
169// Table 1: Manual, DI11, channel 3 in DI10:07.
170static_assert(ManualWord(3_u8, 0_u16) == 0x1980U);
171// Table 1: channel 4, Range 2 (DI06); the channel and control fields are masked to their width.
172static_assert((ManualWord(4_u8, kRangeTwoVref) == 0x1A40U) &&
173 (ManualWord(0x14_u8, 0xFFFF_u16) == 0x1A7FU));
174// Tables 2 and 5: Auto-1 with DI10 (restart); Auto-2 keeps counting with DI06 and GPIO0 high.
175static_assert((AutoWord(kAuto1, true, 0_u16) == 0x2C00U) &&
176 (AutoWord(kAuto2, false, 0x41_u16) == 0x3841U));
177// Table 6: last channel 11 in DI09:06.
178static_assert(Auto2ProgramWord(11_u8) == 0x92C0U);
179// Table 13: group 2 is 1110; channel 3 of a group, high threshold, exit, all ones.
180static_assert((AlarmGroupWord(2_u8) == 0xE000U) && (AlarmGroupWord(3_u8) == 0xF000U));
181static_assert(AlarmThresholdWord(3_u8, true, true, 0x3FF_u16) == 0xF3FFU);
182static_assert(AlarmThresholdWord(0_u8, false, false, 0xFFFF_u16) == 0x03FFU);
183// Section 8.1: DO15:12 the address, DO11:00 the code.
184static_assert((ReplyAddress(0xB123_u16) == 11U) && (ReplyCode(0xB123_u16) == 0x123U));
185
188} // namespace ads7952::reg
189
190#endif // ADS7952_REGISTERS_HPP
Compile-time helpers of the ADS7952 driver: exact hook matching and enumeration checks.
constexpr uint16_t kGpio3PowerDown
DI08: GPIO3 is the power-down input.
Definition ads7952_registers.hpp:61
constexpr uint16_t kAutoReset
DI10, Auto modes: restart the sequence.
Definition ads7952_registers.hpp:48
constexpr uint16_t kAuto2
0011: Auto-2 mode (Table 5).
Definition ads7952_registers.hpp:40
constexpr uint16_t kContinue
0000: keep the mode, ignore DI11:00.
Definition ads7952_registers.hpp:37
constexpr uint16_t kPowerDown
DI05: power down at the next frame's end.
Definition ads7952_registers.hpp:51
constexpr uint16_t kRangeTwoVref
DI06: 0 to 2 x VREF (Range 2).
Definition ads7952_registers.hpp:50
constexpr uint16_t kAlarmExit
DI12: leave the sequence after this frame.
Definition ads7952_registers.hpp:69
constexpr uint32_t kAlarmChannelShift
DI15:14: channel within the group.
Definition ads7952_registers.hpp:67
constexpr uint16_t kAlarmLowReset
Low threshold after reset: all zeros.
Definition ads7952_registers.hpp:72
constexpr uint16_t kManual
0001: Manual mode (Table 1).
Definition ads7952_registers.hpp:38
constexpr uint16_t kReplyCodeMask
DO11:00: the 12-bit result, straight binary.
Definition ads7952_registers.hpp:77
constexpr uint16_t AlarmGroupWord(uint8_t group) noexcept
The first frame of an alarm group's programming sequence.
Definition ads7952_registers.hpp:143
constexpr uint16_t kAlarmProgramGroup0
11bb: alarm group bb (Table 13).
Definition ads7952_registers.hpp:44
constexpr uint16_t kAuto1Program
1000: Auto-1 mask in the next frame.
Definition ads7952_registers.hpp:42
constexpr uint16_t ManualWord(uint8_t channel, uint16_t control) noexcept
A Manual mode word with DI11 = 1: select channel for the next frame and set DI06:00.
Definition ads7952_registers.hpp:109
constexpr uint16_t kControlMask
DI06:00: the bits a mode word programs.
Definition ads7952_registers.hpp:54
constexpr uint16_t kAlarmHigh
DI13: 1 high threshold, 0 low.
Definition ads7952_registers.hpp:68
constexpr uint32_t kChannelsPerAlarmGroup
Table 12: four channels per group.
Definition ads7952_registers.hpp:73
constexpr uint16_t kAlarmThresholdMask
DI09:00: the upper 10 result bits.
Definition ads7952_registers.hpp:70
constexpr uint32_t kCommandShift
DI15:12 hold the command.
Definition ads7952_registers.hpp:35
constexpr uint16_t kAuto2Program
1001: Auto-2 last channel (Table 6).
Definition ads7952_registers.hpp:43
constexpr uint16_t kGpioProgram
0100: GPIO program register (Table 11).
Definition ads7952_registers.hpp:41
constexpr uint8_t ReplyAddress(uint16_t reply) noexcept
The 4-bit field DO15:12 of a reply: the channel the result belongs to (DI04 = 0 in the frame before),...
Definition ads7952_registers.hpp:90
constexpr uint16_t AlarmThresholdWord(uint8_t channel_in_group, bool high, bool exit, uint16_t threshold) noexcept
One alarm threshold frame of a group's programming sequence.
Definition ads7952_registers.hpp:156
constexpr uint16_t kGpioReadout
DI04: next reply carries GPIO3:0 in DO15:12.
Definition ads7952_registers.hpp:52
constexpr uint16_t kGpioDirectionMask
DI03:00: 1 = output.
Definition ads7952_registers.hpp:64
constexpr uint16_t AutoWord(uint16_t mode, bool restart, uint16_t control) noexcept
An Auto-1 or Auto-2 mode word with DI11 = 1.
Definition ads7952_registers.hpp:122
constexpr uint16_t kAlarmHighReset
High threshold after reset: all ones.
Definition ads7952_registers.hpp:71
constexpr uint32_t kGpioAlarmShift
DI06:04: GPIO0/GPIO1 alarm outputs.
Definition ads7952_registers.hpp:63
constexpr uint16_t Auto2ProgramWord(uint8_t last) noexcept
The Auto-2 program word: last becomes the last channel of the Auto-2 sequence.
Definition ads7952_registers.hpp:133
constexpr uint16_t kGpioResetAll
DI09: reset every register next frame.
Definition ads7952_registers.hpp:60
constexpr uint32_t kAuto2LastShift
DI09:06: the last channel of the sequence.
Definition ads7952_registers.hpp:57
constexpr uint16_t kCommandMask
DI15:12.
Definition ads7952_registers.hpp:36
constexpr uint32_t kManualChannelShift
DI10:07, Manual: the next channel.
Definition ads7952_registers.hpp:49
constexpr uint16_t kGpioDataMask
DI03:00: GPIO output levels.
Definition ads7952_registers.hpp:53
constexpr uint16_t kGpio2Range
DI07: GPIO2 is the range input.
Definition ads7952_registers.hpp:62
constexpr uint32_t kReplyAddressShift
DO15:12: channel address or GPIO3:0.
Definition ads7952_registers.hpp:76
constexpr uint16_t kAuto1
0010: Auto-1 mode (Table 2).
Definition ads7952_registers.hpp:39
constexpr uint16_t kProgramEnable
DI11: take DI10:00 (Manual: DI06:00).
Definition ads7952_registers.hpp:47
constexpr uint16_t ReplyCode(uint16_t reply) noexcept
The 12-bit conversion result of a reply, DO11:00.
Definition ads7952_registers.hpp:99
The ADS795x frame format.
Definition ads7952_registers.hpp:26