|
ISF15ACP4 Driver 0.1.0
API reference
|
SSD1331 command set: opcodes, parameter fields, limits and timing (SSD1331 datasheet Rev 1.2, sections 7 to 9 and 12; NKK ISF15ACP4 sheet E7). More...
Go to the source code of this file.
Namespaces | |
| namespace | isf15acp4 |
The ISF15ACP4 driver: everything it declares lives here; internals in detail. | |
| namespace | isf15acp4::reg |
| The SSD1331 command set. | |
Variables | |
Opcodes (Table 10) | |
| constexpr uint8_t | isf15acp4::reg::kSetColumnAddress = 0x15 |
| 15h + start, end (section 9.1.1). | |
| constexpr uint8_t | isf15acp4::reg::kSetRowAddress = 0x75 |
| 75h + start, end (section 9.1.2). | |
| constexpr uint8_t | isf15acp4::reg::kSetContrastA = 0x81 |
| 81h + contrast of colour A (9.1.3). | |
| constexpr uint8_t | isf15acp4::reg::kSetContrastB = 0x82 |
| 82h + contrast of colour B. | |
| constexpr uint8_t | isf15acp4::reg::kSetContrastC = 0x83 |
| 83h + contrast of colour C. | |
| constexpr uint8_t | isf15acp4::reg::kMasterCurrent = 0x87 |
| 87h + attenuation 0..15 (9.1.4). | |
| constexpr uint8_t | isf15acp4::reg::kPrechargeSpeedA |
| 8Ah + second pre-charge speed of colour A (9.1.5). | |
| constexpr uint8_t | isf15acp4::reg::kPrechargeSpeedB = 0x8B |
| 8Bh + speed of colour B. | |
| constexpr uint8_t | isf15acp4::reg::kPrechargeSpeedC = 0x8C |
| 8Ch + speed of colour C. | |
| constexpr uint8_t | isf15acp4::reg::kRemap = 0xA0 |
| A0h + remap and colour depth (9.1.6). | |
| constexpr uint8_t | isf15acp4::reg::kStartLine = 0xA1 |
| A1h + display start line (9.1.7). | |
| constexpr uint8_t | isf15acp4::reg::kDisplayOffset = 0xA2 |
| A2h + display offset (9.1.8). | |
| constexpr uint8_t | isf15acp4::reg::kModeNormal = 0xA4 |
| A4h: normal display (9.1.9). | |
| constexpr uint8_t | isf15acp4::reg::kModeAllOn = 0xA5 |
| A5h: every pixel at GS63. | |
| constexpr uint8_t | isf15acp4::reg::kModeAllOff = 0xA6 |
| A6h: every pixel at GS0. | |
| constexpr uint8_t | isf15acp4::reg::kModeInverse = 0xA7 |
| A7h: GS0 <-> GS63. | |
| constexpr uint8_t | isf15acp4::reg::kMultiplex = 0xA8 |
| A8h + N = multiplex ratio - 1 (9.1.10). | |
| constexpr uint8_t | isf15acp4::reg::kDimMode = 0xAB |
| ABh + five bytes (9.1.11). | |
| constexpr uint8_t | isf15acp4::reg::kMasterConfig = 0xAD |
| ADh + 8Eh: external VCC (9.1.12). | |
| constexpr uint8_t | isf15acp4::reg::kDisplayDim = 0xAC |
| ACh: display on in dim mode (9.1.13). | |
| constexpr uint8_t | isf15acp4::reg::kDisplayOff = 0xAE |
| AEh: display off, sleep. | |
| constexpr uint8_t | isf15acp4::reg::kDisplayOn = 0xAF |
| AFh: display on, normal brightness. | |
| constexpr uint8_t | isf15acp4::reg::kPowerSave = 0xB0 |
| B0h + 1Ah enable or 0Bh disable (9.1.14). | |
| constexpr uint8_t | isf15acp4::reg::kPhasePeriods = 0xB1 |
| B1h + phase 1 and 2 periods (9.1.15). | |
| constexpr uint8_t | isf15acp4::reg::kClockDivider = 0xB3 |
| B3h + divide ratio and frequency (9.1.16). | |
| constexpr uint8_t | isf15acp4::reg::kGrayScaleTable = 0xB8 |
| B8h + 32 pulse widths (9.1.17). | |
| constexpr uint8_t | isf15acp4::reg::kLinearGrayScale = 0xB9 |
| B9h: built-in linear table (9.1.18). | |
| constexpr uint8_t | isf15acp4::reg::kPrechargeLevel = 0xBB |
| BBh + pre-charge voltage (9.1.19). | |
| constexpr uint8_t | isf15acp4::reg::kNopBC = 0xBC |
| BCh: no operation (9.1.21). | |
| constexpr uint8_t | isf15acp4::reg::kNopBD = 0xBD |
| BDh: no operation. | |
| constexpr uint8_t | isf15acp4::reg::kPrechargeBit0 = 0x01 |
| BBh bit 0: reserved; NKK Table 3 sets it. | |
| constexpr uint8_t | isf15acp4::reg::kVcomh = 0xBE |
| BEh + VCOMH level (9.1.20). | |
| constexpr uint8_t | isf15acp4::reg::kNopE3 = 0xE3 |
| E3h: no operation. | |
| constexpr uint8_t | isf15acp4::reg::kCommandLock = 0xFD |
| FDh + 12h unlock or 16h lock (9.1.22). | |
| constexpr uint8_t | isf15acp4::reg::kDrawLine = 0x21 |
| 21h + 7 bytes (9.2.1). | |
| constexpr uint8_t | isf15acp4::reg::kDrawRectangle = 0x22 |
| 22h + 10 bytes (9.2.2). | |
| constexpr uint8_t | isf15acp4::reg::kCopy = 0x23 |
| 23h + 6 bytes (9.2.3). | |
| constexpr uint8_t | isf15acp4::reg::kDimWindow = 0x24 |
| 24h + 4 bytes (9.2.4). | |
| constexpr uint8_t | isf15acp4::reg::kClearWindow = 0x25 |
| 25h + 4 bytes (9.2.5). | |
| constexpr uint8_t | isf15acp4::reg::kFillEnable = 0x26 |
| 26h + fill and reverse-copy bits (9.2.6). | |
| constexpr uint8_t | isf15acp4::reg::kScrollSetup = 0x27 |
| 27h + 5 bytes (9.2.7). | |
| constexpr uint8_t | isf15acp4::reg::kScrollOff = 0x2E |
| 2Eh: stop scrolling (9.2.8). | |
| constexpr uint8_t | isf15acp4::reg::kScrollOn = 0x2F |
| 2Fh: start scrolling (9.2.9). | |
Parameter values | |
| constexpr uint8_t | isf15acp4::reg::kMasterConfigExternalVcc |
| ADh parameter, A[0] = 0 (Table 10 note 1). | |
| constexpr uint8_t | isf15acp4::reg::kPowerSaveEnable = 0x1A |
| B0h parameter: power save on (reset value). | |
| constexpr uint8_t | isf15acp4::reg::kPowerSaveDisable = 0x0B |
| B0h parameter: power save off. | |
| constexpr uint8_t | isf15acp4::reg::kCommandUnlock = 0x12 |
| FDh parameter: unlock (reset value). | |
| constexpr uint8_t | isf15acp4::reg::kCommandLockOn = 0x16 |
| FDh parameter: lock. | |
Limits | |
| constexpr uint8_t | isf15acp4::reg::kRamColumns = 96 |
| GDDRAM width: columns 0 to 95 (section 7.5.1). | |
| constexpr uint8_t | isf15acp4::reg::kRamRows = 64 |
| GDDRAM height: rows 0 to 63. | |
| constexpr uint8_t | isf15acp4::reg::kMuxMin = 16 |
| Lowest multiplex ratio (A8h: N from 15). | |
| constexpr uint8_t | isf15acp4::reg::kMuxMax = 64 |
| Highest multiplex ratio, the reset value. | |
| constexpr uint8_t | isf15acp4::reg::kMasterCurrentMax = 15 |
| 87h: 1/16 to 16/16 (steps 0 to 15). | |
| constexpr uint8_t | isf15acp4::reg::kPrechargeSteps = 31 |
| BBh, BEh, ABh E: A[5:1] 0 to 31. | |
| constexpr uint8_t | isf15acp4::reg::kPhaseMax = 15 |
| B1h: 1 to 15 DCLK per phase. | |
| constexpr std::size_t | isf15acp4::reg::kGrayScaleEntries = 32 |
| B8h: GS1, GS3 ... GS63. | |
| constexpr uint8_t | isf15acp4::reg::kGrayScaleMax = 125 |
| B8h: longest pulse width, in DCLK. | |
| constexpr uint8_t | isf15acp4::reg::kScrollColumnsMax = 95 |
| 27h A: 0 to 95 columns per step. | |
| constexpr uint8_t | isf15acp4::reg::kScrollRowsMax = 63 |
| 27h D: 0 to 63 rows per step. | |
Fill and copy, 26h parameter (section 9.2.6) | |
| constexpr uint32_t | isf15acp4::reg::kFillRectangle = 1U << 0 |
| A[0]: fill the rectangle of 22h. | |
| constexpr uint32_t | isf15acp4::reg::kReverseCopy = 1U << 4 |
| A[4]: swap GS0 <-> GS63 during 23h. | |
Reset values (section 7.4 and Table 10) | |
| constexpr uint8_t | isf15acp4::reg::kResetContrast = 0x80 |
| 81h, 82h, 83h after RES#. | |
| constexpr uint8_t | isf15acp4::reg::kResetMasterCurrent = 0x0F |
| 87h after RES#. | |
| constexpr uint8_t | isf15acp4::reg::kResetRemap = 0x40 |
| A0h after RES#: 65k, horizontal, normal. | |
| constexpr uint8_t | isf15acp4::reg::kResetPhases = 0x74 |
| B1h after RES#. | |
| constexpr uint8_t | isf15acp4::reg::kResetClock = 0xD0 |
| B3h after RES#. | |
| constexpr uint8_t | isf15acp4::reg::kResetPrecharge = 0x3E |
| BBh and BEh after RES#. | |
Times (sections 7.9 and 12, Table 18; NKK sheet E7) | |
| constexpr uint32_t | isf15acp4::reg::kResetPulseMinUs = 3 |
RES# low pulse width, minimum (Table 18, tRW). | |
| constexpr uint32_t | isf15acp4::reg::kResetCompleteMaxUs = 2 |
| Reset completion time, maximum (Table 18). | |
| constexpr uint32_t | isf15acp4::reg::kResetToVccMinUs = 3 |
| RES# low to VCC on, minimum (section 7.9, t2). | |
| constexpr uint32_t | isf15acp4::reg::kDisplayOnDelayMs = 100 |
| AFh to SEG/COM on, maximum (section 7.9, tAF). | |
| constexpr uint32_t | isf15acp4::reg::kVccOffTypicalMs = 100 |
| VCC off to VDD off, minimum 0 and typical 100 ms (section 7.9, tOFF). | |
Remap and colour depth, A0h parameter (section 9.1.6) | |
| using | isf15acp4::reg::RemapDepth = detail::Field< uint8_t, 6U, 2U > |
| A[7:6]: 00 = 256 colours, 01 = 65k format 1 (reset value), 10 = 65k format 2. | |
| constexpr uint32_t | isf15acp4::reg::kRemapVertical = 1U << 0 |
| A[0]: 1 = vertical address increment. | |
| constexpr uint32_t | isf15acp4::reg::kRemapColumnReverse = 1U << 1 |
| A[1]: 1 = RAM column 0 at SEG95. | |
| constexpr uint32_t | isf15acp4::reg::kRemapColourReverse = 1U << 2 |
| A[2]: 1 = order SC, SB, SA. | |
| constexpr uint32_t | isf15acp4::reg::kRemapComSwap = 1U << 3 |
| A[3]: 1 = left-right swap on COM. | |
| constexpr uint32_t | isf15acp4::reg::kRemapComScanReverse = 1U << 4 |
| A[4]: 1 = scan COM[N-1] to COM0. | |
| constexpr uint32_t | isf15acp4::reg::kRemapComSplit = 1U << 5 |
SSD1331 command set: opcodes, parameter fields, limits and timing (SSD1331 datasheet Rev 1.2, sections 7 to 9 and 12; NKK ISF15ACP4 sheet E7).
The display controller has no readable register: serial mode is write only (SSD1331 section 8.1, "No data read is provided in serial mode operation"). This file is therefore a command map, not a register map: every opcode with the number of parameter bytes that follows it, the fields inside the parameter bytes, the reset values and the time limits. Section numbers refer to the SSD1331 datasheet Rev 1.2; "NKK" is the ISF15ACP4 sheet. Every parameter byte is sent with D/C# low, like the opcode (Table 10).