AS5047U Driver 0.1.0
API reference
Loading...
Searching...
No Matches
as5047u_registers.hpp
Go to the documentation of this file.
1
15#ifndef AS5047U_REGISTERS_HPP
16#define AS5047U_REGISTERS_HPP
17
18#include <cstddef>
19#include <cstdint>
20
23namespace as5047u::reg {
24
25// --- Volatile registers ----------------------------------------------------------------------
26
27inline constexpr uint16_t kNop = 0x0000;
28inline constexpr uint16_t kErrfl = 0x0001;
29inline constexpr uint16_t kProg = 0x0003;
30inline constexpr uint16_t kDia = 0x3FF5;
31inline constexpr uint16_t kAgc = 0x3FF9;
32inline constexpr uint16_t kSinData = 0x3FFA;
33inline constexpr uint16_t kCosData = 0x3FFB;
34inline constexpr uint16_t kVel = 0x3FFC;
35inline constexpr uint16_t kMag = 0x3FFD;
36inline constexpr uint16_t kAngleUnc = 0x3FFE;
37inline constexpr uint16_t kAngleCom = 0x3FFF;
38// ECC_s: Figure 40 and OTP procedure step 8 give 0x3FD0; the table of Figure 32 prints 0x00D1.
39inline constexpr uint16_t kEccChecksum = 0x3FD0;
40
41// --- CRC-8 of every 24- and 32-bit frame (Figure 31) -----------------------------------------
42
43inline constexpr uint8_t kCrcPolynomial = 0x1D;
44inline constexpr uint8_t kCrcInit = 0xC4;
45inline constexpr uint8_t kCrcFinalXor = 0xFF;
46
47// --- Non-volatile registers (OTP, with a volatile copy) --------------------------------------
48
49inline constexpr uint16_t kDisable = 0x0015;
50inline constexpr uint16_t kZposm = 0x0016;
51inline constexpr uint16_t kZposl = 0x0017;
52inline constexpr uint16_t kSettings1 = 0x0018;
53inline constexpr uint16_t kSettings2 = 0x0019;
54inline constexpr uint16_t kSettings3 = 0x001A;
55inline constexpr uint16_t kEcc = 0x001B;
56
58inline constexpr uint16_t kFirstNonVolatile = kDisable;
60inline constexpr uint16_t kNonVolatileCount = 7;
61
63enum class NvIndex : uint8_t {
64 Disable = 0,
65 Zposm = 1,
66 Zposl = 2,
67 Settings1 = 3,
68 Settings2 = 4,
69 Settings3 = 5,
70 Ecc = 6,
71};
72
78constexpr std::size_t At(NvIndex index) noexcept {
79 return static_cast<std::size_t>(index);
80}
81static_assert((At(NvIndex::Ecc) + 1U) == kNonVolatileCount);
82
84inline constexpr uint16_t kDisableImplemented = 0x7F;
86inline constexpr uint16_t kNvByteImplemented = 0xFF;
87
94constexpr uint16_t NvImplementedBits(std::size_t index) noexcept {
96}
98
99// --- Frame bits --------------------------------------------------------------------------------
100
102inline constexpr uint16_t kDataMask = 0x3FFF;
104inline constexpr uint16_t kReadBit = 1U << 14;
106inline constexpr uint16_t kReplyErrorBit = 1U << 14;
108inline constexpr uint16_t kReplyWarningBit = 1U << 15;
110inline constexpr uint16_t kReplyFlagBits = uint32_t{kReplyErrorBit} | uint32_t{kReplyWarningBit};
111
112// --- ERRFL (Figure 33): cleared on the chip by reading it ------------------------------------
113
114inline constexpr uint16_t kErrflAgcWarning = 1U << 0;
115inline constexpr uint16_t kErrflMagHalf = 1U << 1;
116inline constexpr uint16_t kErrflP2ramWarning = 1U << 2;
117inline constexpr uint16_t kErrflP2ramError = 1U << 3;
118inline constexpr uint16_t kErrflFraming = 1U << 4;
119inline constexpr uint16_t kErrflCommand = 1U << 5;
120inline constexpr uint16_t kErrflCrc = 1U << 6;
121inline constexpr uint16_t kErrflWatchdog = 1U << 7;
122inline constexpr uint16_t kErrflOffComp = 1U << 9;
123inline constexpr uint16_t kErrflCordic = 1U << 10;
125inline constexpr uint16_t kErrflFrameRejected =
126 uint32_t{kErrflFraming} | uint32_t{kErrflCommand} | uint32_t{kErrflCrc};
128inline constexpr uint16_t kErrflDeviceFault = uint32_t{kErrflP2ramError} |
129 uint32_t{kErrflWatchdog} | uint32_t{kErrflOffComp} |
130 uint32_t{kErrflCordic};
133inline constexpr uint16_t kErrflFieldWarning = uint32_t{kErrflAgcWarning} | uint32_t{kErrflMagHalf};
135inline constexpr uint16_t kErrflReserved = 1U << 8;
139inline constexpr uint16_t kErrflResetHint = uint32_t{kErrflOffComp} | uint32_t{kErrflWatchdog};
140
141// --- PROG (Figure 34) --------------------------------------------------------------------------
142
143inline constexpr uint16_t kProgEnable = 1U << 0;
144inline constexpr uint16_t kProgRefresh = 1U << 2;
145inline constexpr uint16_t kProgBurn = 1U << 3;
146inline constexpr uint16_t kProgVerify = 1U << 6;
148inline constexpr uint16_t kProgDone = kProgEnable;
149
150// --- DIA (Figure 35) ---------------------------------------------------------------------------
151
152inline constexpr uint16_t kDiaVdd5V = 1U << 0;
153inline constexpr uint16_t kDiaLoopsFinished = 1U << 1;
154inline constexpr uint16_t kDiaCordicOverflow = 1U << 2;
155inline constexpr uint16_t kDiaCompLow = 1U << 3;
156inline constexpr uint16_t kDiaCompHigh = 1U << 4;
157inline constexpr uint16_t kDiaMagHalf = 1U << 5;
158inline constexpr uint16_t kDiaCosOffsetDone = 1U << 6;
159inline constexpr uint16_t kDiaSinOffsetDone = 1U << 7;
160inline constexpr uint16_t kDiaOffsetCompDone = 1U << 8;
161inline constexpr uint16_t kDiaAgcDone = 1U << 9;
162inline constexpr uint16_t kDiaSpiCountShift = 11;
163inline constexpr uint16_t kDiaSpiCountMask = 0x3U << 11;
167inline constexpr uint16_t kDiaReserved = 1U << 10;
169inline constexpr uint16_t kDiaReadyValue = 0x03C2;
170
171// --- DISABLE (Figure 43) -----------------------------------------------------------------------
172
173inline constexpr uint16_t kDisableUvwOff = 1U << 0;
174inline constexpr uint16_t kDisableAbiOff = 1U << 1;
175inline constexpr uint16_t kDisableFilterOff = 1U << 6;
176
177// --- ZPOSM / ZPOSL (Figures 44, 45) ------------------------------------------------------------
178
179inline constexpr uint16_t kZposmMask = 0xFFU;
180inline constexpr uint16_t kZposlMask = 0x3FU;
181inline constexpr uint16_t kZposlDiaBits = 0xC0U;
182inline constexpr uint16_t kZeroHighShift = 6;
183
184// --- SETTINGS1 (Figure 46) ---------------------------------------------------------------------
185
186inline constexpr uint16_t kS1KmaxMask = 0x07U;
187inline constexpr uint16_t kS1KminShift = 3;
188inline constexpr uint16_t kS1KminMask = 0x07U << 3;
189inline constexpr uint16_t kS1DiaBits = 0xC0U;
190
191// --- SETTINGS2 (Figure 47) ---------------------------------------------------------------------
192
193inline constexpr uint16_t kS2IndexWidth1 = 1U << 0;
194inline constexpr uint16_t kS2NoiseSet = 1U << 1;
195inline constexpr uint16_t kS2Dir = 1U << 2;
196inline constexpr uint16_t kS2UvwAbi = 1U << 3;
197inline constexpr uint16_t kS2DaecDis = 1U << 4;
198inline constexpr uint16_t kS2AbiDecimal = 1U << 5;
199inline constexpr uint16_t kS2DataSelect = 1U << 6;
200inline constexpr uint16_t kS2PwmOn = 1U << 7;
201
202// --- SETTINGS3 (Figure 48) ---------------------------------------------------------------------
203
204inline constexpr uint16_t kS3UvwppMask = 0x07U;
205inline constexpr uint16_t kS3HysShift = 3;
206inline constexpr uint16_t kS3HysMask = 0x03U << 3;
207inline constexpr uint16_t kS3AbiresShift = 5;
208inline constexpr uint16_t kS3AbiresMask = 0x07U << 5;
209
210// --- ECC (Figure 49) and ECC_s (Figure 40) -----------------------------------------------------
211
212inline constexpr uint16_t kEccChecksumMask = 0x7FU;
213inline constexpr uint16_t kEccEnable = 1U << 7;
214
215} // namespace as5047u::reg
216
217#endif // AS5047U_REGISTERS_HPP
Register addresses and fields of the AS5047U (datasheet section "Register Description").
Definition as5047u_registers.hpp:23
constexpr uint16_t kFirstNonVolatile
First non-volatile register (DISABLE).
Definition as5047u_registers.hpp:58
constexpr uint16_t kEccChecksum
ECC_Checksum: ECC key of the OTP content.
Definition as5047u_registers.hpp:39
constexpr uint8_t kCrcPolynomial
x^8 + x^4 + x^3 + x^2 + 1, not reflected.
Definition as5047u_registers.hpp:43
constexpr uint16_t kErrflCordic
Definition as5047u_registers.hpp:123
constexpr uint16_t kDiaReadyValue
DIA after power-up once every loop has settled, 3.3 V mode, SPI_cnt 0 (Figure 32: 0xX3C2).
Definition as5047u_registers.hpp:169
constexpr uint16_t kZeroHighShift
Zero position bits 13..6 go in ZPOSM.
Definition as5047u_registers.hpp:182
constexpr uint16_t kErrfl
ERRFL: error flags, cleared by a read (Figure 33).
Definition as5047u_registers.hpp:28
constexpr uint16_t kDisableFilterOff
FILTER_disable: adaptive filter off.
Definition as5047u_registers.hpp:175
constexpr uint16_t kAgc
AGC: automatic gain control value.
Definition as5047u_registers.hpp:31
constexpr uint16_t kDiaOffsetCompDone
Offset compensation finished.
Definition as5047u_registers.hpp:160
constexpr uint16_t kDiaVdd5V
VDD_mode: 1 = 5 V operation.
Definition as5047u_registers.hpp:152
constexpr uint16_t NvImplementedBits(std::size_t index) noexcept
The bits a non-volatile register implements; the datasheet describes no others, so the driver expects...
Definition as5047u_registers.hpp:94
constexpr uint16_t kNvByteImplemented
ZPOSM to ECC implement bits 7..0 (Figures 44 to 49).
Definition as5047u_registers.hpp:86
constexpr uint16_t kProgEnable
PROGEN: enable OTP programming.
Definition as5047u_registers.hpp:143
constexpr uint16_t kDiaReserved
Definition as5047u_registers.hpp:167
constexpr uint16_t kS2PwmOn
PWMon: PWM output on.
Definition as5047u_registers.hpp:200
constexpr uint16_t kDiaMagHalf
Field at half the regulated value.
Definition as5047u_registers.hpp:157
constexpr uint16_t kErrflCommand
Invalid SPI command.
Definition as5047u_registers.hpp:119
constexpr uint16_t kDiaSpiCountMask
Definition as5047u_registers.hpp:163
constexpr uint16_t kErrflP2ramError
ECC found an uncorrectable P2RAM error.
Definition as5047u_registers.hpp:117
constexpr uint16_t kZposlMask
ZPOSL bits 5..0 hold zero-position bits 5..0.
Definition as5047u_registers.hpp:180
constexpr uint16_t kDisable
DISABLE: output and filter disable.
Definition as5047u_registers.hpp:49
constexpr uint16_t kEcc
ECC: ECC checksum and enable.
Definition as5047u_registers.hpp:55
constexpr uint16_t kDiaAgcDone
AGC loop finished.
Definition as5047u_registers.hpp:161
constexpr uint16_t kErrflFrameRejected
The flags that mean the last frame was rejected.
Definition as5047u_registers.hpp:125
constexpr uint16_t kVel
VEL: angular velocity (signed 14 bit).
Definition as5047u_registers.hpp:34
constexpr uint16_t kAngleCom
ANGLECOM: angle with DAEC.
Definition as5047u_registers.hpp:37
constexpr uint16_t kDiaSpiCountShift
SPI_cnt: frame counter, bits 12..11.
Definition as5047u_registers.hpp:162
constexpr uint16_t kErrflMagHalf
Field at half the regulated value.
Definition as5047u_registers.hpp:115
constexpr uint16_t kErrflReserved
ERRFL bit 8 has no function and reads 0 (Figure 33): set, the reply cannot be ERRFL.
Definition as5047u_registers.hpp:135
constexpr uint16_t kNonVolatileCount
Number of non-volatile registers, DISABLE to ECC.
Definition as5047u_registers.hpp:60
constexpr uint16_t kErrflDeviceFault
The flags that mean the measurement path is faulty.
Definition as5047u_registers.hpp:128
constexpr uint16_t kErrflWatchdog
Internal oscillator or watchdog fault.
Definition as5047u_registers.hpp:121
constexpr uint16_t kErrflAgcWarning
AGC at its minimum or maximum.
Definition as5047u_registers.hpp:114
constexpr uint16_t kMag
MAG: CORDIC magnitude.
Definition as5047u_registers.hpp:35
constexpr uint16_t kDia
DIA: diagnostics (Figure 35).
Definition as5047u_registers.hpp:30
constexpr uint16_t kNop
NOP: no operation (Figure 32).
Definition as5047u_registers.hpp:27
constexpr uint16_t kS3AbiresShift
ABIRES, bits 7..5.
Definition as5047u_registers.hpp:207
constexpr uint16_t kDiaCompLow
AGC at its low limit.
Definition as5047u_registers.hpp:155
constexpr uint16_t kAngleUnc
ANGLEUNC: angle without DAEC.
Definition as5047u_registers.hpp:36
constexpr uint16_t kDisableUvwOff
UVW_off: UVW pins tristate.
Definition as5047u_registers.hpp:173
constexpr uint8_t kCrcInit
Initial value.
Definition as5047u_registers.hpp:44
constexpr uint16_t kSettings3
SETTINGS3: UVW pole pairs, hysteresis, ABIRES.
Definition as5047u_registers.hpp:54
constexpr uint16_t kDisableImplemented
DISABLE implements bits 6..0 (UVW_off, ABI_off, bits 5..2 "na", FILTER_disable; Figure 43).
Definition as5047u_registers.hpp:84
constexpr uint16_t kS1KminMask
K_min mask.
Definition as5047u_registers.hpp:188
constexpr uint16_t kS3UvwppMask
UVWPP: pole pairs minus one, bits 2..0.
Definition as5047u_registers.hpp:204
constexpr uint16_t kS1KmaxMask
K_max code, bits 2..0.
Definition as5047u_registers.hpp:186
constexpr uint16_t kZposm
ZPOSM: zero position, bits 13..6.
Definition as5047u_registers.hpp:50
constexpr uint16_t kSettings1
SETTINGS1: velocity filter K_max, K_min.
Definition as5047u_registers.hpp:52
constexpr std::size_t At(NvIndex index) noexcept
The array index of a non-volatile register.
Definition as5047u_registers.hpp:78
constexpr uint16_t kS2DataSelect
Data_select: 0x3FFF reads ANGLEUNC.
Definition as5047u_registers.hpp:199
constexpr uint16_t kDataMask
The 14 address or data bits of a frame word.
Definition as5047u_registers.hpp:102
constexpr uint16_t kS3AbiresMask
ABIRES mask.
Definition as5047u_registers.hpp:208
constexpr uint16_t kS2AbiDecimal
ABI_DEC: decimal ABI resolution.
Definition as5047u_registers.hpp:198
constexpr uint16_t kErrflOffComp
Offset compensation not finished.
Definition as5047u_registers.hpp:122
constexpr uint16_t kDiaCordicOverflow
CORDIC overflow.
Definition as5047u_registers.hpp:154
constexpr uint16_t kS1KminShift
K_min code, bits 5..3.
Definition as5047u_registers.hpp:187
constexpr uint16_t kSinData
SINDATA: raw sine channel (signed 14 bit).
Definition as5047u_registers.hpp:32
constexpr uint16_t kDisableAbiOff
ABI_off: A, B and I pins tristate.
Definition as5047u_registers.hpp:174
constexpr uint16_t kErrflFieldWarning
Definition as5047u_registers.hpp:133
constexpr uint16_t kErrflP2ramWarning
ECC corrected one bit in P2RAM.
Definition as5047u_registers.hpp:116
constexpr uint16_t kZposlDiaBits
ZPOSL bits 7..6: Dia1_en, Dia2_en (kept).
Definition as5047u_registers.hpp:181
NvIndex
Index of a non-volatile register in NonVolatileRegisters (address order from DISABLE).
Definition as5047u_registers.hpp:63
@ Ecc
ECC (0x001B).
@ Zposm
ZPOSM (0x0016).
@ Zposl
ZPOSL (0x0017).
@ Settings3
SETTINGS3 (0x001A).
@ Disable
DISABLE (0x0015).
@ Settings1
SETTINGS1 (0x0018).
@ Settings2
SETTINGS2 (0x0019).
constexpr uint16_t kS2NoiseSet
NOISESET: reduced noise at 150 °C, 3.3 V.
Definition as5047u_registers.hpp:194
constexpr uint16_t kReplyWarningBit
MISO word: bit 15, a warning flag is set in ERRFL (Figures 22, 25, 28).
Definition as5047u_registers.hpp:108
constexpr uint16_t kZposl
ZPOSL: zero position, bits 5..0, and Dia1/Dia2.
Definition as5047u_registers.hpp:51
constexpr uint16_t kS2Dir
DIR: invert the rotation direction.
Definition as5047u_registers.hpp:195
constexpr uint16_t kErrflCrc
CRC error on a MOSI frame.
Definition as5047u_registers.hpp:120
constexpr uint16_t kProgBurn
PROGOTP: start burning the OTP.
Definition as5047u_registers.hpp:145
constexpr uint16_t kErrflResetHint
Definition as5047u_registers.hpp:139
constexpr uint16_t kS2UvwAbi
UVW_ABI: 0 = ABI with PWM on W, 1 = UVW.
Definition as5047u_registers.hpp:196
constexpr uint16_t kReplyFlagBits
Both flag bits of a MISO word: when neither is set, the data bits are the whole answer.
Definition as5047u_registers.hpp:110
constexpr uint16_t kEccChecksumMask
ECC_chsum / ECC_s: the 7-bit key.
Definition as5047u_registers.hpp:212
constexpr uint16_t kProg
PROG: OTP programming control (Figure 34).
Definition as5047u_registers.hpp:29
constexpr uint16_t kDiaSinOffsetDone
Sine offset loop finished.
Definition as5047u_registers.hpp:159
constexpr uint16_t kS3HysMask
HYS mask.
Definition as5047u_registers.hpp:206
constexpr uint16_t kErrflFraming
SPI framing error.
Definition as5047u_registers.hpp:118
constexpr uint16_t kS2IndexWidth1
IWIDTH: 1 = 1 LSB index pulse, 0 = 3 LSB.
Definition as5047u_registers.hpp:193
constexpr uint16_t kS1DiaBits
Dia3_en, Dia4_en (kept).
Definition as5047u_registers.hpp:189
constexpr uint16_t kProgVerify
Definition as5047u_registers.hpp:146
constexpr uint16_t kReplyErrorBit
MISO word: bit 14, an error flag is set in ERRFL (Figures 22, 25, 28).
Definition as5047u_registers.hpp:106
constexpr uint8_t kCrcFinalXor
XORed into the result.
Definition as5047u_registers.hpp:45
constexpr uint16_t kProgDone
PROG reads PROGEN alone once a burn has finished (OTP flowchart, Figure 60).
Definition as5047u_registers.hpp:148
constexpr uint16_t kS3HysShift
HYS, bits 4..3.
Definition as5047u_registers.hpp:205
constexpr uint16_t kSettings2
SETTINGS2: direction, DAEC, outputs.
Definition as5047u_registers.hpp:53
constexpr uint16_t kDiaLoopsFinished
All magnetic loops have settled.
Definition as5047u_registers.hpp:153
constexpr uint16_t kProgRefresh
OTPREF: reload the registers from the OTP.
Definition as5047u_registers.hpp:144
constexpr uint16_t kCosData
COSDATA: raw cosine channel (signed 14 bit).
Definition as5047u_registers.hpp:33
constexpr uint16_t kDiaCosOffsetDone
Cosine offset loop finished.
Definition as5047u_registers.hpp:158
constexpr uint16_t kReadBit
MOSI command word: bit 14 = 1 read, 0 write (Figures 21, 24, 27).
Definition as5047u_registers.hpp:104
constexpr uint16_t kEccEnable
ECC_en.
Definition as5047u_registers.hpp:213
constexpr uint16_t kS2DaecDis
DAECDIS: dynamic compensation off.
Definition as5047u_registers.hpp:197
constexpr uint16_t kZposmMask
ZPOSM holds zero-position bits 13..6.
Definition as5047u_registers.hpp:179
constexpr uint16_t kDiaCompHigh
AGC at its high limit.
Definition as5047u_registers.hpp:156