uc8151 0.2.0

no_std library for the UC8151(IL0373) e-ink display with embedded-graphics support
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290

#[repr(u8)]
pub enum Instruction {
    PSR = 0x00,
    PWR = 0x01,
    POF = 0x02,
    PFS = 0x03,
    PON = 0x04,
    PMES = 0x05,
    BTST = 0x06,
    DSLP = 0x07,
    DTM1 = 0x10,
    DSP = 0x11,
    DRF = 0x12,
    DTM2 = 0x13,
    LUT_VCOM = 0x20,
    LUT_WW = 0x21,
    LUT_BW = 0x22,
    LUT_WB = 0x23,
    LUT_BB = 0x24,
    PLL = 0x30,
    TSC = 0x40,
    TSE = 0x41,
    TSR = 0x43,
    TSW = 0x42,
    CDI = 0x50,
    LPD = 0x51,
    TCON = 0x60,
    TRES = 0x61,
    REV = 0x70,
    FLG = 0x71,
    AMV = 0x80,
    VV = 0x81,
    VDCS = 0x82,
    PTL = 0x90,
    PTIN = 0x91,
    PTOU = 0x92,
    PGM = 0xa0,
    APG = 0xa1,
    ROTP = 0xa2,
    CCSET = 0xe0,
    PWS = 0xe3,
    TSSET = 0xe5,
}

pub mod psrflags {
    pub const RES_96X230: PsrFlags = 0b00000000;
    pub const RES_96X252: PsrFlags = 0b01000000;
    pub const RES_128X296: PsrFlags = 0b10000000;
    pub const RES_160X296: PsrFlags = 0b11000000;

    /// Use lookup table from OTP memory
    pub const LUT_OTP: PsrFlags = 0b00000000;
    /// Use lookup table from Register
    pub const LUT_REG: PsrFlags = 0b00100000;

    pub const FORMAT_BWR: PsrFlags = 0b00000000;
    pub const FORMAT_BW: PsrFlags = 0b00010000;

    pub const SCAN_DOWN: PsrFlags = 0b00000000;
    pub const SCAN_UP: PsrFlags = 0b00001000;

    pub const SHIFT_LEFT: PsrFlags = 0b00000000;
    pub const SHIFT_RIGHT: PsrFlags = 0b00000100;

    pub const BOOSTER_OFF: PsrFlags = 0b00000000;
    pub const BOOSTER_ON: PsrFlags = 0b00000010;

    pub const RESET_SOFT: PsrFlags = 0b00000000;
    pub const RESET_NONE: PsrFlags = 0b00000001;
    pub type PsrFlags = u8;
}

pub mod pwr_flags_1 {
    pub const VDS_EXTERNAL: PwrFlags1 = 0b00000000;
    pub const VDS_INTERNAL: PwrFlags1 = 2;

    pub const VDG_EXTERNAL: PwrFlags1 = 0b00000000;
    pub const VDG_INTERNAL: PwrFlags1 = 1;
    pub type PwrFlags1 = u8;
}

pub mod pwr_flags_2 {
    pub const VCOM_VD: PwrFlags2 = 0b00000000;
    pub const VCOM_VG: PwrFlags2 = 4;

    pub const VGHL_16V: PwrFlags2 = 0;
    pub const VGHL_15V: PwrFlags2 = 1;
    pub const VGHL_14V: PwrFlags2 = 2;
    pub const VGHL_13V: PwrFlags2 = 3;
    pub type PwrFlags2 = u8;
}

pub mod booster_flags {
    pub const START_10MS: BoosterFlags = 0b00000000;
    pub const START_20MS: BoosterFlags = 0b01000000;
    pub const START_30MS: BoosterFlags = 0b10000000;
    pub const START_40MS: BoosterFlags = 0b11000000;

    pub const STRENGTH_1: BoosterFlags = 0b00000000;
    pub const STRENGTH_2: BoosterFlags = 0b00001000;
    pub const STRENGTH_3: BoosterFlags = 0b00010000;
    pub const STRENGTH_4: BoosterFlags = 0b00011000;
    pub const STRENGTH_5: BoosterFlags = 0b00100000;
    pub const STRENGTH_6: BoosterFlags = 0b00101000;
    pub const STRENGTH_7: BoosterFlags = 0b00110000;
    pub const STRENGTH_8: BoosterFlags = 0b00111000;

    pub const OFF_0_27US: BoosterFlags = 0;
    pub const OFF_0_34US: BoosterFlags = 1;
    pub const OFF_0_40US: BoosterFlags = 2;
    pub const OFF_0_54US: BoosterFlags = 3;
    pub const OFF_0_80US: BoosterFlags = 4;
    pub const OFF_1_54US: BoosterFlags = 5;
    pub const OFF_3_34US: BoosterFlags = 6;
    pub const OFF_6_58US: BoosterFlags = 7;
    pub type BoosterFlags = u8;
}

pub mod pfs_flags {
    pub const FRAMES_1: PfsFlags = 0b00000000;
    pub const FRAMES_2: PfsFlags = 0b00010000;
    pub const FRAMES_3: PfsFlags = 0b00100000;
    pub const FRAMES_4: PfsFlags = 0b00110000;
    pub type PfsFlags = u8;
}

pub mod tse_flags {
    pub const TEMP_INTERNAL: TseFlags = 0b00000000;
    pub const TEMP_EXTERNAL: TseFlags = 0b10000000;
    pub const OFFSET_0: TseFlags = 0;
    pub const OFFSET_1: TseFlags = 1;
    pub const OFFSET_2: TseFlags = 2;
    pub const OFFSET_3: TseFlags = 3;
    pub const OFFSET_4: TseFlags = 4;
    pub const OFFSET_5: TseFlags = 5;
    pub const OFFSET_6: TseFlags = 6;
    pub const OFFSET_7: TseFlags = 7;

    pub const OFFSET_MIN_8: TseFlags = 8;
    pub const OFFSET_MIN_7: TseFlags = 9;
    pub const OFFSET_MIN_6: TseFlags = 10;
    pub const OFFSET_MIN_5: TseFlags = 11;
    pub const OFFSET_MIN_4: TseFlags = 12;
    pub const OFFSET_MIN_3: TseFlags = 13;
    pub const OFFSET_MIN_2: TseFlags = 14;
    pub const OFFSET_MIN_1: TseFlags = 15;
    pub type TseFlags = u8;
}

pub mod pll_flags {
    pub const HZ_29: PllFlags = 0b00_111_111;
    pub const HZ_33: PllFlags = 0b00_111_110;
    pub const HZ_40: PllFlags = 0b00_111_101;
    pub const HZ_50: PllFlags = 0b00_111_100;
    pub const HZ_67: PllFlags = 0b00_111_011;
    pub const HZ_100: PllFlags = 0b00_111_010;
    pub const HZ_150: PllFlags = 0b00_101_001;
    pub const HZ_200: PllFlags = 0b00_111_001;
    pub type PllFlags = u8;
}

pub struct Lut {
    pub vcom: [u8; 44],
    pub ww: [u8; 42],
    pub bw: [u8; 42],
    pub wb: [u8; 42],
    pub bb: [u8; 42],
    pub update_time: u16,
    pub pll: pll_flags::PllFlags,
}

pub const DEFAULT_LUT: Lut = Lut {
    vcom: [
        0x00, 0x64, 0x64, 0x37, 0x00, 0x01, 0x00, 0x8c, 0x8c, 0x00, 0x00, 0x04, 0x00, 0x64, 0x64,
        0x37, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    ww: [
        0x54, 0x64, 0x64, 0x37, 0x00, 0x01, 0x60, 0x8c, 0x8c, 0x00, 0x00, 0x04, 0xa8, 0x64, 0x64,
        0x37, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    bw: [
        0x54, 0x64, 0x64, 0x37, 0x00, 0x01, 0x60, 0x8c, 0x8c, 0x00, 0x00, 0x04, 0xa8, 0x64, 0x64,
        0x37, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    wb: [
        0xa8, 0x64, 0x64, 0x37, 0x00, 0x01, 0x60, 0x8c, 0x8c, 0x00, 0x00, 0x04, 0x54, 0x64, 0x64,
        0x37, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    bb: [
        0xa8, 0x64, 0x64, 0x37, 0x00, 0x01, 0x60, 0x8c, 0x8c, 0x00, 0x00, 0x04, 0x54, 0x64, 0x64,
        0x37, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    update_time: 4500,
    pll: pll_flags::HZ_100,
};

pub const MEDIUM_LUT: Lut = Lut {
    vcom: [
        0x00, 0x16, 0x16, 0x0d, 0x00, 0x01, 0x00, 0x23, 0x23, 0x00, 0x00, 0x02, 0x00, 0x16, 0x16,
        0x0d, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    ww: [
        0x54, 0x16, 0x16, 0x0d, 0x00, 0x01, 0x60, 0x23, 0x23, 0x00, 0x00, 0x02, 0xa8, 0x16, 0x16,
        0x0d, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    bw: [
        0x54, 0x16, 0x16, 0x0d, 0x00, 0x01, 0x60, 0x23, 0x23, 0x00, 0x00, 0x02, 0xa8, 0x16, 0x16,
        0x0d, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    wb: [
        0xa8, 0x16, 0x16, 0x0d, 0x00, 0x01, 0x60, 0x23, 0x23, 0x00, 0x00, 0x02, 0x54, 0x16, 0x16,
        0x0d, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    bb: [
        0xa8, 0x16, 0x16, 0x0d, 0x00, 0x01, 0x60, 0x23, 0x23, 0x00, 0x00, 0x02, 0x54, 0x16, 0x16,
        0x0d, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    update_time: 2000,
    pll: pll_flags::HZ_100,
};

pub const FAST_LUT: Lut = Lut {
    vcom: [
        0x00, 0x04, 0x04, 0x07, 0x00, 0x01, 0x00, 0x0c, 0x0c, 0x00, 0x00, 0x02, 0x00, 0x04, 0x04,
        0x07, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    ww: [
        0x54, 0x04, 0x04, 0x07, 0x00, 0x01, 0x60, 0x0c, 0x0c, 0x00, 0x00, 0x02, 0xa8, 0x04, 0x04,
        0x07, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    bw: [
        0x54, 0x04, 0x04, 0x07, 0x00, 0x01, 0x60, 0x0c, 0x0c, 0x00, 0x00, 0x02, 0xa8, 0x04, 0x04,
        0x07, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    wb: [
        0xa8, 0x04, 0x04, 0x07, 0x00, 0x01, 0x60, 0x0c, 0x0c, 0x00, 0x00, 0x02, 0x54, 0x04, 0x04,
        0x07, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    bb: [
        0xa8, 0x04, 0x04, 0x07, 0x00, 0x01, 0x60, 0x0c, 0x0c, 0x00, 0x00, 0x02, 0x54, 0x04, 0x04,
        0x07, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    update_time: 800,
    pll: pll_flags::HZ_100, // TODO: work out why this doesn't work at 200hz
};

pub const ULTRA_LUT: Lut = Lut {
    vcom: [
        0x00, 0x01, 0x01, 0x02, 0x00, 0x01, 0x00, 0x02, 0x02, 0x00, 0x00, 0x02, 0x00, 0x02, 0x02,
        0x03, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    ww: [
        0x54, 0x01, 0x01, 0x02, 0x00, 0x01, 0x60, 0x02, 0x02, 0x00, 0x00, 0x02, 0xa8, 0x02, 0x02,
        0x03, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    bw: [
        0x54, 0x01, 0x01, 0x02, 0x00, 0x01, 0x60, 0x02, 0x02, 0x00, 0x00, 0x02, 0xa8, 0x02, 0x02,
        0x03, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    wb: [
        0xa8, 0x01, 0x01, 0x02, 0x00, 0x01, 0x60, 0x02, 0x02, 0x00, 0x00, 0x02, 0x54, 0x02, 0x02,
        0x03, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    bb: [
        0xa8, 0x01, 0x01, 0x02, 0x00, 0x01, 0x60, 0x02, 0x02, 0x00, 0x00, 0x02, 0x54, 0x02, 0x02,
        0x03, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
        0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
    ],
    update_time: 250,
    pll: pll_flags::HZ_100, // TODO: work out why these don't work at 200hz
};