ISF15ACP4 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
isf15acp4_registers.hpp
Go to the documentation of this file.
1
15#ifndef ISF15ACP4_REGISTERS_HPP
16#define ISF15ACP4_REGISTERS_HPP
17
18#include <array>
19#include <cstddef>
20#include <cstdint>
21
22#include "isf15acp4_detail.hpp"
23
25namespace isf15acp4::reg {
26
27using detail::operator""_u8;
28using detail::operator""_u32;
29
38inline constexpr uint8_t kSetColumnAddress = 0x15;
39inline constexpr uint8_t kSetRowAddress = 0x75;
40inline constexpr uint8_t kSetContrastA = 0x81;
41inline constexpr uint8_t kSetContrastB = 0x82;
42inline constexpr uint8_t kSetContrastC = 0x83;
43inline constexpr uint8_t kMasterCurrent = 0x87;
44inline constexpr uint8_t kPrechargeSpeedA =
45 0x8A;
46inline constexpr uint8_t kPrechargeSpeedB = 0x8B;
47inline constexpr uint8_t kPrechargeSpeedC = 0x8C;
48inline constexpr uint8_t kRemap = 0xA0;
49inline constexpr uint8_t kStartLine = 0xA1;
50inline constexpr uint8_t kDisplayOffset = 0xA2;
51inline constexpr uint8_t kModeNormal = 0xA4;
52inline constexpr uint8_t kModeAllOn = 0xA5;
53inline constexpr uint8_t kModeAllOff = 0xA6;
54inline constexpr uint8_t kModeInverse = 0xA7;
55inline constexpr uint8_t kMultiplex = 0xA8;
56inline constexpr uint8_t kDimMode = 0xAB;
57inline constexpr uint8_t kMasterConfig = 0xAD;
58inline constexpr uint8_t kDisplayDim = 0xAC;
59inline constexpr uint8_t kDisplayOff = 0xAE;
60inline constexpr uint8_t kDisplayOn = 0xAF;
61inline constexpr uint8_t kPowerSave = 0xB0;
62inline constexpr uint8_t kPhasePeriods = 0xB1;
63inline constexpr uint8_t kClockDivider = 0xB3;
64inline constexpr uint8_t kGrayScaleTable = 0xB8;
65inline constexpr uint8_t kLinearGrayScale = 0xB9;
66inline constexpr uint8_t kPrechargeLevel = 0xBB;
67inline constexpr uint8_t kNopBC = 0xBC;
68inline constexpr uint8_t kNopBD = 0xBD;
69inline constexpr uint8_t kPrechargeBit0 = 0x01;
70inline constexpr uint8_t kVcomh = 0xBE;
71inline constexpr uint8_t kNopE3 = 0xE3;
72inline constexpr uint8_t kCommandLock = 0xFD;
73inline constexpr uint8_t kDrawLine = 0x21;
74inline constexpr uint8_t kDrawRectangle = 0x22;
75inline constexpr uint8_t kCopy = 0x23;
76inline constexpr uint8_t kDimWindow = 0x24;
77inline constexpr uint8_t kClearWindow = 0x25;
78inline constexpr uint8_t kFillEnable = 0x26;
79inline constexpr uint8_t kScrollSetup = 0x27;
80inline constexpr uint8_t kScrollOff = 0x2E;
81inline constexpr uint8_t kScrollOn = 0x2F;
83
86inline constexpr uint8_t kMasterConfigExternalVcc =
87 0x8E;
88inline constexpr uint8_t kPowerSaveEnable = 0x1A;
89inline constexpr uint8_t kPowerSaveDisable = 0x0B;
90inline constexpr uint8_t kCommandUnlock = 0x12;
91inline constexpr uint8_t kCommandLockOn = 0x16;
93
96inline constexpr uint8_t kRamColumns = 96;
97inline constexpr uint8_t kRamRows = 64;
98inline constexpr uint8_t kMuxMin = 16;
99inline constexpr uint8_t kMuxMax = 64;
100inline constexpr uint8_t kMasterCurrentMax = 15;
101inline constexpr uint8_t kPrechargeSteps = 31;
102inline constexpr uint8_t kPhaseMax = 15;
103inline constexpr std::size_t kGrayScaleEntries = 32;
104inline constexpr uint8_t kGrayScaleMax = 125;
105inline constexpr uint8_t kScrollColumnsMax = 95;
106inline constexpr uint8_t kScrollRowsMax = 63;
108
111inline constexpr uint32_t kRemapVertical = 1U << 0;
112inline constexpr uint32_t kRemapColumnReverse = 1U << 1;
113inline constexpr uint32_t kRemapColourReverse = 1U << 2;
114inline constexpr uint32_t kRemapComSwap = 1U << 3;
115inline constexpr uint32_t kRemapComScanReverse = 1U << 4;
116inline constexpr uint32_t kRemapComSplit = 1U << 5;
118using RemapDepth = detail::Field<uint8_t, 6U, 2U>;
120
123inline constexpr uint32_t kFillRectangle = 1U << 0;
124inline constexpr uint32_t kReverseCopy = 1U << 4;
126
129
131using PhaseOne = detail::Field<uint8_t, 0U, 4U>;
133using PhaseTwo = detail::Field<uint8_t, 4U, 4U>;
135using ClockDivide = detail::Field<uint8_t, 0U, 4U>;
137using ClockFrequency = detail::Field<uint8_t, 4U, 4U>;
139using Level5 = detail::Field<uint8_t, 1U, 5U>;
141using ScrollInterval = detail::Field<uint8_t, 0U, 2U>;
143
146inline constexpr uint8_t kResetContrast = 0x80;
147inline constexpr uint8_t kResetMasterCurrent = 0x0F;
148inline constexpr uint8_t kResetRemap = 0x40;
149inline constexpr uint8_t kResetPhases = 0x74;
150inline constexpr uint8_t kResetClock = 0xD0;
151inline constexpr uint8_t kResetPrecharge = 0x3E;
153
156
158inline constexpr uint32_t kResetPulseMinUs = 3;
160inline constexpr uint32_t kResetCompleteMaxUs = 2;
162inline constexpr uint32_t kResetToVccMinUs = 3;
164inline constexpr uint32_t kDisplayOnDelayMs = 100;
166inline constexpr uint32_t kVccOffTypicalMs = 100;
168
171// Frame geometry and sizes the rest of the driver relies on.
172static_assert((static_cast<uint32_t>(kRamColumns) * kRamRows) == 6144U,
173 "96 x 64 pixels (section 2)");
174static_assert(RemapDepth::kMax == 3U, "A0h A[7:6] is a 2-bit field");
175static_assert(Level5::kMask == 0x3EU, "BBh, BEh: A[5:1], bit 0 clear");
176static_assert(PhaseOne::kMask == 0x0FU, "B1h: phase 1 in bits 3..0");
177static_assert(ClockFrequency::kMask == 0xF0U, "B3h: frequency in bits 7..4");
178
179} // namespace isf15acp4::reg
180
181#endif // ISF15ACP4_REGISTERS_HPP
constexpr uint8_t kScrollOff
2Eh: stop scrolling (9.2.8).
Definition isf15acp4_registers.hpp:80
constexpr uint32_t kRemapComSplit
Definition isf15acp4_registers.hpp:116
constexpr uint8_t kResetMasterCurrent
87h after RES#.
Definition isf15acp4_registers.hpp:147
constexpr uint8_t kDimWindow
24h + 4 bytes (9.2.4).
Definition isf15acp4_registers.hpp:76
constexpr uint8_t kGrayScaleMax
B8h: longest pulse width, in DCLK.
Definition isf15acp4_registers.hpp:104
constexpr uint32_t kRemapComSwap
A[3]: 1 = left-right swap on COM.
Definition isf15acp4_registers.hpp:114
constexpr uint8_t kModeInverse
A7h: GS0 <-> GS63.
Definition isf15acp4_registers.hpp:54
constexpr uint8_t kDisplayOffset
A2h + display offset (9.1.8).
Definition isf15acp4_registers.hpp:50
constexpr uint8_t kDrawRectangle
22h + 10 bytes (9.2.2).
Definition isf15acp4_registers.hpp:74
constexpr uint8_t kScrollRowsMax
27h D: 0 to 63 rows per step.
Definition isf15acp4_registers.hpp:106
constexpr uint8_t kSetContrastA
81h + contrast of colour A (9.1.3).
Definition isf15acp4_registers.hpp:40
constexpr uint8_t kLinearGrayScale
B9h: built-in linear table (9.1.18).
Definition isf15acp4_registers.hpp:65
constexpr uint8_t kResetContrast
81h, 82h, 83h after RES#.
Definition isf15acp4_registers.hpp:146
constexpr std::size_t kGrayScaleEntries
B8h: GS1, GS3 ... GS63.
Definition isf15acp4_registers.hpp:103
constexpr uint32_t kDisplayOnDelayMs
AFh to SEG/COM on, maximum (section 7.9, tAF).
Definition isf15acp4_registers.hpp:164
detail::Field< uint8_t, 1U, 5U > Level5
BBh and BEh: a 5-bit level in bits 5..1 (bit 0 is 0). (ABh E is a raw 5-bit level in bits 4....
Definition isf15acp4_registers.hpp:139
constexpr uint32_t kResetPulseMinUs
RES# low pulse width, minimum (Table 18, tRW).
Definition isf15acp4_registers.hpp:158
constexpr uint8_t kGrayScaleTable
B8h + 32 pulse widths (9.1.17).
Definition isf15acp4_registers.hpp:64
constexpr uint8_t kModeAllOn
A5h: every pixel at GS63.
Definition isf15acp4_registers.hpp:52
constexpr uint8_t kPrechargeSpeedC
8Ch + speed of colour C.
Definition isf15acp4_registers.hpp:47
constexpr uint8_t kModeNormal
A4h: normal display (9.1.9).
Definition isf15acp4_registers.hpp:51
constexpr uint8_t kPowerSaveEnable
B0h parameter: power save on (reset value).
Definition isf15acp4_registers.hpp:88
constexpr uint8_t kDisplayOff
AEh: display off, sleep.
Definition isf15acp4_registers.hpp:59
detail::Field< uint8_t, 6U, 2U > RemapDepth
A[7:6]: 00 = 256 colours, 01 = 65k format 1 (reset value), 10 = 65k format 2.
Definition isf15acp4_registers.hpp:118
constexpr uint8_t kSetRowAddress
75h + start, end (section 9.1.2).
Definition isf15acp4_registers.hpp:39
constexpr uint32_t kVccOffTypicalMs
VCC off to VDD off, minimum 0 and typical 100 ms (section 7.9, tOFF).
Definition isf15acp4_registers.hpp:166
constexpr uint8_t kDisplayOn
AFh: display on, normal brightness.
Definition isf15acp4_registers.hpp:60
detail::Field< uint8_t, 0U, 4U > ClockDivide
B3h: divide ratio D - 1 in bits 3..0 (section 9.1.16).
Definition isf15acp4_registers.hpp:135
constexpr uint8_t kNopBD
BDh: no operation.
Definition isf15acp4_registers.hpp:68
constexpr uint8_t kCommandLock
FDh + 12h unlock or 16h lock (9.1.22).
Definition isf15acp4_registers.hpp:72
constexpr uint8_t kMasterConfigExternalVcc
ADh parameter, A[0] = 0 (Table 10 note 1).
Definition isf15acp4_registers.hpp:86
constexpr uint8_t kPhaseMax
B1h: 1 to 15 DCLK per phase.
Definition isf15acp4_registers.hpp:102
constexpr uint8_t kMuxMin
Lowest multiplex ratio (A8h: N from 15).
Definition isf15acp4_registers.hpp:98
constexpr uint8_t kPhasePeriods
B1h + phase 1 and 2 periods (9.1.15).
Definition isf15acp4_registers.hpp:62
constexpr uint32_t kResetToVccMinUs
RES# low to VCC on, minimum (section 7.9, t2).
Definition isf15acp4_registers.hpp:162
constexpr uint8_t kNopE3
E3h: no operation.
Definition isf15acp4_registers.hpp:71
constexpr uint8_t kRamColumns
GDDRAM width: columns 0 to 95 (section 7.5.1).
Definition isf15acp4_registers.hpp:96
constexpr uint8_t kRamRows
GDDRAM height: rows 0 to 63.
Definition isf15acp4_registers.hpp:97
constexpr uint8_t kPrechargeBit0
BBh bit 0: reserved; NKK Table 3 sets it.
Definition isf15acp4_registers.hpp:69
constexpr uint8_t kSetColumnAddress
15h + start, end (section 9.1.1).
Definition isf15acp4_registers.hpp:38
constexpr uint8_t kClockDivider
B3h + divide ratio and frequency (9.1.16).
Definition isf15acp4_registers.hpp:63
constexpr uint32_t kRemapVertical
A[0]: 1 = vertical address increment.
Definition isf15acp4_registers.hpp:111
constexpr uint8_t kResetRemap
A0h after RES#: 65k, horizontal, normal.
Definition isf15acp4_registers.hpp:148
constexpr uint8_t kScrollSetup
27h + 5 bytes (9.2.7).
Definition isf15acp4_registers.hpp:79
constexpr uint8_t kResetPhases
B1h after RES#.
Definition isf15acp4_registers.hpp:149
constexpr uint8_t kScrollColumnsMax
27h A: 0 to 95 columns per step.
Definition isf15acp4_registers.hpp:105
constexpr uint8_t kDisplayDim
ACh: display on in dim mode (9.1.13).
Definition isf15acp4_registers.hpp:58
detail::Field< uint8_t, 4U, 4U > ClockFrequency
B3h: oscillator frequency in bits 7..4.
Definition isf15acp4_registers.hpp:137
constexpr uint8_t kResetPrecharge
BBh and BEh after RES#.
Definition isf15acp4_registers.hpp:151
constexpr uint8_t kSetContrastB
82h + contrast of colour B.
Definition isf15acp4_registers.hpp:41
constexpr uint8_t kDrawLine
21h + 7 bytes (9.2.1).
Definition isf15acp4_registers.hpp:73
detail::Field< uint8_t, 0U, 2U > ScrollInterval
27h E: the scroll interval in bits 1..0.
Definition isf15acp4_registers.hpp:141
constexpr uint8_t kSetContrastC
83h + contrast of colour C.
Definition isf15acp4_registers.hpp:42
constexpr uint8_t kPowerSaveDisable
B0h parameter: power save off.
Definition isf15acp4_registers.hpp:89
constexpr uint8_t kPrechargeSpeedB
8Bh + speed of colour B.
Definition isf15acp4_registers.hpp:46
constexpr uint32_t kRemapColumnReverse
A[1]: 1 = RAM column 0 at SEG95.
Definition isf15acp4_registers.hpp:112
constexpr uint8_t kFillEnable
26h + fill and reverse-copy bits (9.2.6).
Definition isf15acp4_registers.hpp:78
constexpr uint8_t kMasterCurrent
87h + attenuation 0..15 (9.1.4).
Definition isf15acp4_registers.hpp:43
constexpr uint8_t kClearWindow
25h + 4 bytes (9.2.5).
Definition isf15acp4_registers.hpp:77
detail::Field< uint8_t, 4U, 4U > PhaseTwo
B1h phase 2 (bits 7..4).
Definition isf15acp4_registers.hpp:133
constexpr uint8_t kRemap
A0h + remap and colour depth (9.1.6).
Definition isf15acp4_registers.hpp:48
constexpr uint8_t kPowerSave
B0h + 1Ah enable or 0Bh disable (9.1.14).
Definition isf15acp4_registers.hpp:61
detail::Field< uint8_t, 0U, 4U > PhaseOne
B1h: phase 1 in bits 3..0, phase 2 in bits 7..4 (section 9.1.15).
Definition isf15acp4_registers.hpp:131
constexpr uint8_t kCopy
23h + 6 bytes (9.2.3).
Definition isf15acp4_registers.hpp:75
constexpr uint32_t kFillRectangle
A[0]: fill the rectangle of 22h.
Definition isf15acp4_registers.hpp:123
constexpr uint8_t kPrechargeSpeedA
8Ah + second pre-charge speed of colour A (9.1.5).
Definition isf15acp4_registers.hpp:44
constexpr uint32_t kResetCompleteMaxUs
Reset completion time, maximum (Table 18).
Definition isf15acp4_registers.hpp:160
constexpr uint32_t kRemapColourReverse
A[2]: 1 = order SC, SB, SA.
Definition isf15acp4_registers.hpp:113
constexpr uint8_t kMasterCurrentMax
87h: 1/16 to 16/16 (steps 0 to 15).
Definition isf15acp4_registers.hpp:100
constexpr uint8_t kVcomh
BEh + VCOMH level (9.1.20).
Definition isf15acp4_registers.hpp:70
constexpr uint8_t kStartLine
A1h + display start line (9.1.7).
Definition isf15acp4_registers.hpp:49
constexpr uint8_t kCommandUnlock
FDh parameter: unlock (reset value).
Definition isf15acp4_registers.hpp:90
constexpr uint8_t kScrollOn
2Fh: start scrolling (9.2.9).
Definition isf15acp4_registers.hpp:81
constexpr uint8_t kNopBC
BCh: no operation (9.1.21).
Definition isf15acp4_registers.hpp:67
constexpr uint8_t kResetClock
B3h after RES#.
Definition isf15acp4_registers.hpp:150
constexpr uint8_t kMultiplex
A8h + N = multiplex ratio - 1 (9.1.10).
Definition isf15acp4_registers.hpp:55
constexpr uint8_t kPrechargeSteps
BBh, BEh, ABh E: A[5:1] 0 to 31.
Definition isf15acp4_registers.hpp:101
constexpr uint8_t kPrechargeLevel
BBh + pre-charge voltage (9.1.19).
Definition isf15acp4_registers.hpp:66
constexpr uint8_t kCommandLockOn
FDh parameter: lock.
Definition isf15acp4_registers.hpp:91
constexpr uint8_t kModeAllOff
A6h: every pixel at GS0.
Definition isf15acp4_registers.hpp:53
constexpr uint8_t kDimMode
ABh + five bytes (9.1.11).
Definition isf15acp4_registers.hpp:56
constexpr uint32_t kRemapComScanReverse
A[4]: 1 = scan COM[N-1] to COM0.
Definition isf15acp4_registers.hpp:115
constexpr uint8_t kMasterConfig
ADh + 8Eh: external VCC (9.1.12).
Definition isf15acp4_registers.hpp:57
constexpr uint8_t kMuxMax
Highest multiplex ratio, the reset value.
Definition isf15acp4_registers.hpp:99
constexpr uint32_t kReverseCopy
A[4]: swap GS0 <-> GS63 during 23h.
Definition isf15acp4_registers.hpp:124
Compile-time helpers of the ISF15ACP4 driver: typed integer literals, exact hook matching,...
The SSD1331 command set.
Definition isf15acp4_registers.hpp:25