upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYour Name <you@example.com>2026-05-18 16:12:13 +0530
committerYour Name <you@example.com>2026-05-18 16:12:13 +0530
commit52f852f5b987750537b71e2a5f2363a48783a985 (patch)
treee43006899d241e0c2221dca924ba2bedb1aae2bb
parent36fa7451a3be1c49932e944859364fe4e9f9fcc4 (diff)
track: add AXS15231B display driver and QR code components
Components were untracked on master. Adding to feature/display-fix branch so they are version-controlled before making QSPI fixes.
-rw-r--r--components/axs15231b/CMakeLists.txt3
-rw-r--r--components/axs15231b/axs15231b.c282
-rw-r--r--components/axs15231b/include/axs15231b.h27
-rw-r--r--components/qrcode/CMakeLists.txt2
-rwxr-xr-xcomponents/qrcode/include/qrcoded.h85
-rwxr-xr-xcomponents/qrcode/qrcoded.c1054
6 files changed, 1453 insertions, 0 deletions
diff --git a/components/axs15231b/CMakeLists.txt b/components/axs15231b/CMakeLists.txt
new file mode 100644
index 0000000..033a05e
--- /dev/null
+++ b/components/axs15231b/CMakeLists.txt
@@ -0,0 +1,3 @@
1idf_component_register(SRCS "axs15231b.c"
2 INCLUDE_DIRS "include"
3 REQUIRES driver esp_timer)
diff --git a/components/axs15231b/axs15231b.c b/components/axs15231b/axs15231b.c
new file mode 100644
index 0000000..dd7145a
--- /dev/null
+++ b/components/axs15231b/axs15231b.c
@@ -0,0 +1,282 @@
1#include "axs15231b.h"
2#include "driver/spi_master.h"
3#include "driver/gpio.h"
4#include "esp_log.h"
5#include "esp_timer.h"
6#include "freertos/FreeRTOS.h"
7#include "freertos/task.h"
8#include <string.h>
9#include <stdlib.h>
10#include <esp_heap_caps.h>
11
12static const char *TAG = "axs15231b";
13
14#define SWRESET 0x01
15#define SLPIN 0x10
16#define SLPOUT 0x11
17#define INVOFF 0x20
18#define INVON 0x21
19#define DISPOFF 0x28
20#define DISPON 0x29
21#define CASET 0x2A
22#define RASET 0x2B
23#define RAMWR 0x2C
24#define COLMOD 0x3A
25#define MADCTL 0x36
26
27#define MADCTL_MY 0x80
28#define MADCTL_MX 0x40
29#define MADCTL_MV 0x20
30#define MADCTL_RGB 0x00
31
32static spi_device_handle_t s_spi = NULL;
33static uint16_t *s_fb = NULL;
34static int s_width = AXS15231B_WIDTH;
35static int s_height = AXS15231B_HEIGHT;
36
37typedef struct {
38 uint8_t cmd;
39 uint8_t data_len;
40 const uint8_t *data;
41 uint16_t delay_ms;
42} init_cmd_t;
43
44static esp_err_t send_cmd(uint8_t cmd) {
45 spi_transaction_t t = {0};
46 t.length = 8;
47 t.tx_data[0] = cmd;
48 t.flags = SPI_TRANS_USE_TXDATA;
49 return spi_device_polling_transmit(s_spi, &t);
50}
51
52static esp_err_t send_data(const uint8_t *data, int len) {
53 if (len == 0) return ESP_OK;
54 spi_transaction_t t = {0};
55 t.length = len * 8;
56 t.tx_buffer = data;
57 t.flags = 0;
58 return spi_device_polling_transmit(s_spi, &t);
59}
60
61static esp_err_t send_cmd_data(uint8_t cmd, const uint8_t *data, int len) {
62 esp_err_t ret = send_cmd(cmd);
63 if (ret != ESP_OK) return ret;
64 if (len > 0) ret = send_data(data, len);
65 return ret;
66}
67
68static const uint8_t init_bb[] = {0x00,0x00,0x00,0x00,0x00,0x00,0x5A,0xA5};
69static const uint8_t init_a0[] = {0xC0,0x10,0x00,0x02,0x00,0x00,0x04,0x3F,0x20,0x05,0x3F,0x3F,0x00,0x00,0x00,0x00,0x00};
70static const uint8_t init_a2[] = {0x30,0x3C,0x24,0x14,0xD0,0x20,0xFF,0xE0,0x40,0x19,0x80,0x80,0x80,0x20,0xF9,0x10,0x02,0xFF,0xFF,0xF0,0x90,0x01,0x32,0xA0,0x91,0xE0,0x20,0x7F,0xFF,0x00,0x5A};
71static const uint8_t init_d0[] = {0xE0,0x40,0x51,0x24,0x08,0x05,0x10,0x01,0x20,0x15,0xC2,0x42,0x22,0x22,0xAA,0x03,0x10,0x12,0x60,0x14,0x1E,0x51,0x15,0x00,0x8A,0x20,0x00,0x03,0x3A,0x12};
72static const uint8_t init_a3[] = {0xA0,0x06,0xAA,0x00,0x08,0x02,0x0A,0x04,0x04,0x04,0x04,0x04,0x04,0x04,0x04,0x04,0x04,0x04,0x04,0x00,0x55,0x55};
73static const uint8_t init_c1[] = {0x31,0x04,0x02,0x02,0x71,0x05,0x24,0x55,0x02,0x00,0x41,0x00,0x53,0xFF,0xFF,0xFF,0x4F,0x52,0x00,0x4F,0x52,0x00,0x45,0x3B,0x0B,0x02,0x0D,0x00,0xFF,0x40};
74static const uint8_t init_c3[] = {0x00,0x00,0x00,0x50,0x03,0x00,0x00,0x00,0x01,0x80,0x01};
75static const uint8_t init_c4[] = {0x00,0x24,0x33,0x80,0x00,0xEA,0x64,0x32,0xC8,0x64,0xC8,0x32,0x90,0x90,0x11,0x06,0xDC,0xFA,0x00,0x00,0x80,0xFE,0x10,0x10,0x00,0x0A,0x0A,0x44,0x50};
76static const uint8_t init_c5[] = {0x18,0x00,0x00,0x03,0xFE,0x3A,0x4A,0x20,0x30,0x10,0x88,0xDE,0x0D,0x08,0x0F,0x0F,0x01,0x3A,0x4A,0x20,0x10,0x10,0x00};
77static const uint8_t init_c6[] = {0x05,0x0A,0x05,0x0A,0x00,0xE0,0x2E,0x0B,0x12,0x22,0x12,0x22,0x01,0x03,0x00,0x3F,0x6A,0x18,0xC8,0x22};
78static const uint8_t init_c7[] = {0x50,0x32,0x28,0x00,0xA2,0x80,0x8F,0x00,0x80,0xFF,0x07,0x11,0x9C,0x67,0xFF,0x24,0x0C,0x0D,0x0E,0x0F};
79static const uint8_t init_c9[] = {0x33,0x44,0x44,0x01};
80static const uint8_t init_cf[] = {0x2C,0x1E,0x88,0x58,0x13,0x18,0x56,0x18,0x1E,0x68,0x88,0x00,0x65,0x09,0x22,0xC4,0x0C,0x77,0x22,0x44,0xAA,0x55,0x08,0x08,0x12,0xA0,0x08};
81static const uint8_t init_d5[] = {0x40,0x8E,0x8D,0x01,0x35,0x04,0x92,0x74,0x04,0x92,0x74,0x04,0x08,0x6A,0x04,0x46,0x03,0x03,0x03,0x03,0x82,0x01,0x03,0x00,0xE0,0x51,0xA1,0x00,0x00,0x00};
82static const uint8_t init_d6[] = {0x10,0x32,0x54,0x76,0x98,0xBA,0xDC,0xFE,0x93,0x00,0x01,0x83,0x07,0x07,0x00,0x07,0x07,0x00,0x03,0x03,0x03,0x03,0x03,0x03,0x00,0x84,0x00,0x20,0x01,0x00};
83static const uint8_t init_d7[] = {0x03,0x01,0x0B,0x09,0x0F,0x0D,0x1E,0x1F,0x18,0x1D,0x1F,0x19,0x40,0x8E,0x04,0x00,0x20,0xA0,0x1F};
84static const uint8_t init_d8[] = {0x02,0x00,0x0A,0x08,0x0E,0x0C,0x1E,0x1F,0x18,0x1D,0x1F,0x19};
85static const uint8_t init_d9[] = {0x1F,0x1F,0x1F,0x1F,0x1F,0x1F,0x1F,0x1F,0x1F,0x1F,0x1F,0x1F};
86static const uint8_t init_dd[] = {0x1F,0x1F,0x1F,0x1F,0x1F,0x1F,0x1F,0x1F,0x1F,0x1F,0x1F,0x1F};
87static const uint8_t init_df[] = {0x44,0x73,0x4B,0x69,0x00,0x0A,0x02,0x90};
88static const uint8_t init_e0[] = {0x3B,0x28,0x10,0x16,0x0C,0x06,0x11,0x28,0x5C,0x21,0x0D,0x35,0x13,0x2C,0x33,0x28,0x0D};
89static const uint8_t init_e1[] = {0x37,0x28,0x10,0x16,0x0B,0x06,0x11,0x28,0x5C,0x21,0x0D,0x35,0x14,0x2C,0x33,0x28,0x0F};
90static const uint8_t init_e2[] = {0x3B,0x07,0x12,0x18,0x0E,0x0D,0x17,0x35,0x44,0x32,0x0C,0x14,0x14,0x36,0x3A,0x2F,0x0D};
91static const uint8_t init_e3[] = {0x37,0x07,0x12,0x18,0x0E,0x0D,0x17,0x35,0x44,0x32,0x0C,0x14,0x14,0x36,0x32,0x2F,0x0F};
92static const uint8_t init_e4[] = {0x3B,0x07,0x12,0x18,0x0E,0x0D,0x17,0x39,0x44,0x2E,0x0C,0x14,0x14,0x36,0x3A,0x2F,0x0D};
93static const uint8_t init_e5[] = {0x37,0x07,0x12,0x18,0x0E,0x0D,0x17,0x39,0x44,0x2E,0x0C,0x14,0x14,0x36,0x3A,0x2F,0x0F};
94static const uint8_t init_a4_1[] = {0x85,0x85,0x95,0x82,0xAF,0xAA,0xAA,0x80,0x10,0x30,0x40,0x40,0x20,0xFF,0x60,0x30};
95static const uint8_t init_a4_2[] = {0x85,0x85,0x95,0x85};
96static const uint8_t init_bb2[] = {0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00};
97
98static const init_cmd_t s_init_cmds[] = {
99 {0xBB, sizeof(init_bb), init_bb, 0},
100 {0xA0, sizeof(init_a0), init_a0, 0},
101 {0xA2, sizeof(init_a2), init_a2, 0},
102 {0xD0, sizeof(init_d0), init_d0, 0},
103 {0xA3, sizeof(init_a3), init_a3, 0},
104 {0xC1, sizeof(init_c1), init_c1, 0},
105 {0xC3, sizeof(init_c3), init_c3, 0},
106 {0xC4, sizeof(init_c4), init_c4, 0},
107 {0xC5, sizeof(init_c5), init_c5, 0},
108 {0xC6, sizeof(init_c6), init_c6, 0},
109 {0xC7, sizeof(init_c7), init_c7, 0},
110 {0xC9, sizeof(init_c9), init_c9, 0},
111 {0xCF, sizeof(init_cf), init_cf, 0},
112 {0xD5, sizeof(init_d5), init_d5, 0},
113 {0xD6, sizeof(init_d6), init_d6, 0},
114 {0xD7, sizeof(init_d7), init_d7, 0},
115 {0xD8, sizeof(init_d8), init_d8, 0},
116 {0xD9, sizeof(init_d9), init_d9, 0},
117 {0xDD, sizeof(init_dd), init_dd, 0},
118 {0xDF, sizeof(init_df), init_df, 0},
119 {0xE0, sizeof(init_e0), init_e0, 0},
120 {0xE1, sizeof(init_e1), init_e1, 0},
121 {0xE2, sizeof(init_e2), init_e2, 0},
122 {0xE3, sizeof(init_e3), init_e3, 0},
123 {0xE4, sizeof(init_e4), init_e4, 0},
124 {0xE5, sizeof(init_e5), init_e5, 0},
125 {0xA4, sizeof(init_a4_1), init_a4_1, 0},
126 {0xA4, sizeof(init_a4_2), init_a4_2, 0},
127 {0xBB, sizeof(init_bb2), init_bb2, 0},
128 {SLPOUT, 0, NULL, 200},
129 {DISPON, 0, NULL, 100},
130};
131#define INIT_CMD_COUNT (sizeof(s_init_cmds) / sizeof(s_init_cmds[0]))
132
133esp_err_t axs15231b_init(void) {
134 ESP_LOGI(TAG, "Initializing AXS15231B display...");
135
136 esp_err_t ret;
137
138 spi_bus_config_t buscfg = {
139 .mosi_io_num = AXS15231B_PIN_D0,
140 .sclk_io_num = AXS15231B_PIN_CLK,
141 .miso_io_num = -1,
142 .quadwp_io_num = -1,
143 .quadhd_io_num = -1,
144 .max_transfer_sz = 32768,
145 };
146
147 spi_device_interface_config_t devcfg = {
148 .clock_speed_hz = 40 * 1000 * 1000,
149 .mode = 0,
150 .spics_io_num = AXS15231B_PIN_CS,
151 .queue_size = 7,
152 .flags = 0,
153 };
154
155 ret = spi_bus_initialize(SPI2_HOST, &buscfg, SPI_DMA_CH_AUTO);
156 if (ret != ESP_OK) {
157 ESP_LOGE(TAG, "Failed to init SPI bus: %s", esp_err_to_name(ret));
158 return ret;
159 }
160
161 ret = spi_bus_add_device(SPI2_HOST, &devcfg, &s_spi);
162 if (ret != ESP_OK) {
163 ESP_LOGE(TAG, "Failed to add SPI device: %s", esp_err_to_name(ret));
164 return ret;
165 }
166
167 size_t fb_size = (size_t)s_width * s_height * 2;
168 s_fb = heap_caps_malloc(fb_size, MALLOC_CAP_SPIRAM | MALLOC_CAP_8BIT);
169 if (!s_fb) {
170 ESP_LOGE(TAG, "Failed to allocate framebuffer (%zu bytes)", fb_size);
171 return ESP_ERR_NO_MEM;
172 }
173 memset(s_fb, 0, fb_size);
174 ESP_LOGI(TAG, "Framebuffer allocated: %zu bytes in PSRAM", fb_size);
175
176 gpio_config_t bl_cfg = {
177 .pin_bit_mask = (1ULL << AXS15231B_PIN_BL),
178 .mode = GPIO_MODE_OUTPUT,
179 .pull_up_en = GPIO_PULLUP_DISABLE,
180 .pull_down_en = GPIO_PULLDOWN_DISABLE,
181 .intr_type = GPIO_INTR_DISABLE,
182 };
183 gpio_config(&bl_cfg);
184
185 send_cmd(SWRESET);
186 vTaskDelay(pdMS_TO_TICKS(200));
187
188 for (int i = 0; i < INIT_CMD_COUNT; i++) {
189 ret = send_cmd_data(s_init_cmds[i].cmd, s_init_cmds[i].data, s_init_cmds[i].data_len);
190 if (ret != ESP_OK) {
191 ESP_LOGE(TAG, "Init cmd 0x%02X failed: %s", s_init_cmds[i].cmd, esp_err_to_name(ret));
192 return ret;
193 }
194 if (s_init_cmds[i].delay_ms > 0) {
195 vTaskDelay(pdMS_TO_TICKS(s_init_cmds[i].delay_ms));
196 }
197 }
198
199 uint8_t madctl_val = MADCTL_MX | MADCTL_MV | MADCTL_RGB;
200 ret = send_cmd_data(MADCTL, &madctl_val, 1);
201 if (ret != ESP_OK) {
202 ESP_LOGE(TAG, "Failed to set rotation: %s", esp_err_to_name(ret));
203 return ret;
204 }
205
206 uint8_t colmod_val = 0x55;
207 ret = send_cmd_data(COLMOD, &colmod_val, 1);
208 if (ret != ESP_OK) {
209 ESP_LOGE(TAG, "Failed to set pixel format: %s", esp_err_to_name(ret));
210 return ret;
211 }
212
213 axs15231b_fill_screen(0x0000);
214 axs15231b_flush();
215
216 axs15231b_set_backlight(true);
217
218 ESP_LOGI(TAG, "AXS15231B initialized: %dx%d landscape", s_width, s_height);
219 return ESP_OK;
220}
221
222void axs15231b_set_backlight(bool on) {
223 gpio_set_level(AXS15231B_PIN_BL, on ? 1 : 0);
224}
225
226void axs15231b_fill_screen(uint16_t color) {
227 uint32_t pixels = (uint32_t)s_width * s_height;
228 for (uint32_t i = 0; i < pixels; i++) {
229 s_fb[i] = color;
230 }
231}
232
233void axs15231b_fill_rect(int x, int y, int w, int h, uint16_t color) {
234 if (x < 0 || y < 0 || x + w > s_width || y + h > s_height) return;
235 for (int row = y; row < y + h; row++) {
236 for (int col = x; col < x + w; col++) {
237 s_fb[row * s_width + col] = color;
238 }
239 }
240}
241
242void axs15231b_flush(void) {
243 if (!s_spi || !s_fb) return;
244
245 uint8_t buf[4];
246 buf[0] = 0;
247 buf[1] = 0;
248 buf[2] = (s_width - 1) >> 8;
249 buf[3] = (s_width - 1) & 0xFF;
250 send_cmd_data(CASET, buf, 4);
251
252 buf[0] = 0;
253 buf[1] = 0;
254 buf[2] = (s_height - 1) >> 8;
255 buf[3] = (s_height - 1) & 0xFF;
256 send_cmd_data(RASET, buf, 4);
257
258 send_cmd(RAMWR);
259
260 int total_bytes = s_width * s_height * 2;
261 int chunk_size = 32768;
262 int offset = 0;
263 uint8_t *fb_bytes = (uint8_t *)s_fb;
264
265 while (offset < total_bytes) {
266 int remaining = total_bytes - offset;
267 int this_chunk = remaining < chunk_size ? remaining : chunk_size;
268
269 spi_transaction_t t = {0};
270 t.length = this_chunk * 8;
271 t.tx_buffer = fb_bytes + offset;
272 esp_err_t ret = spi_device_polling_transmit(s_spi, &t);
273 if (ret != ESP_OK) {
274 ESP_LOGE(TAG, "Flush transfer failed at offset %d: %s", offset, esp_err_to_name(ret));
275 return;
276 }
277 offset += this_chunk;
278 }
279}
280
281int axs15231b_get_width(void) { return s_width; }
282int axs15231b_get_height(void) { return s_height; }
diff --git a/components/axs15231b/include/axs15231b.h b/components/axs15231b/include/axs15231b.h
new file mode 100644
index 0000000..5ec017c
--- /dev/null
+++ b/components/axs15231b/include/axs15231b.h
@@ -0,0 +1,27 @@
1#ifndef AXS15231B_H
2#define AXS15231B_H
3
4#include "esp_err.h"
5#include <stdint.h>
6#include <stdbool.h>
7
8#define AXS15231B_WIDTH 480
9#define AXS15231B_HEIGHT 320
10
11#define AXS15231B_PIN_CS 45
12#define AXS15231B_PIN_CLK 47
13#define AXS15231B_PIN_D0 21
14#define AXS15231B_PIN_D1 48
15#define AXS15231B_PIN_D2 40
16#define AXS15231B_PIN_D3 39
17#define AXS15231B_PIN_BL 1
18
19esp_err_t axs15231b_init(void);
20void axs15231b_set_backlight(bool on);
21void axs15231b_fill_screen(uint16_t color);
22void axs15231b_fill_rect(int x, int y, int w, int h, uint16_t color);
23void axs15231b_flush(void);
24int axs15231b_get_width(void);
25int axs15231b_get_height(void);
26
27#endif
diff --git a/components/qrcode/CMakeLists.txt b/components/qrcode/CMakeLists.txt
new file mode 100644
index 0000000..347aeed
--- /dev/null
+++ b/components/qrcode/CMakeLists.txt
@@ -0,0 +1,2 @@
1idf_component_register(SRCS "qrcoded.c"
2 INCLUDE_DIRS "include")
diff --git a/components/qrcode/include/qrcoded.h b/components/qrcode/include/qrcoded.h
new file mode 100755
index 0000000..602f9c0
--- /dev/null
+++ b/components/qrcode/include/qrcoded.h
@@ -0,0 +1,85 @@
1/**
2 * The MIT License (MIT)
3 *
4 * This library is written and maintained by Richard Moore.
5 * Major parts were derived from Project Nayuki's library.
6 *
7 * Copyright (c) 2017 Richard Moore (https://github.com/ricmoo/QRCode)
8 * Copyright (c) 2017 Project Nayuki (https://www.nayuki.io/page/qr-code-generator-library)
9 *
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 * THE SOFTWARE.
27 */
28
29/**
30 * Special thanks to Nayuki (https://www.nayuki.io/) from which this library was
31 * heavily inspired and compared against.
32 *
33 * See: https://github.com/nayuki/QR-Code-generator/tree/master/cpp
34 */
35
36#ifndef __QRCODE_H_
37#define __QRCODE_H_
38
39#include <stdbool.h>
40#include <stdint.h>
41
42// QR Code Format Encoding
43#define MODE_NUMERIC 0
44#define MODE_ALPHANUMERIC 1
45#define MODE_BYTE 2
46
47// Error Correction Code Levels
48#define ECC_LOW 0
49#define ECC_MEDIUM 1
50#define ECC_QUARTILE 2
51#define ECC_HIGH 3
52
53// If set to non-zero, this library can ONLY produce QR codes at that version
54// This saves a lot of dynamic memory, as the codeword tables are skipped
55#ifndef LOCK_VERSION
56#define LOCK_VERSION 0
57#endif
58
59typedef struct QRCode
60{
61 uint8_t version;
62 uint8_t size;
63 uint8_t ecc;
64 uint8_t mode;
65 uint8_t mask;
66 uint8_t *modules;
67} QRCode;
68
69#ifdef __cplusplus
70extern "C"
71{
72#endif /* __cplusplus */
73
74 uint16_t qrcode_getBufferSize(uint8_t version);
75
76 int8_t qrcode_initText(QRCode *qrcoded, uint8_t *modules, uint8_t version, uint8_t ecc, const char *data);
77 int8_t qrcode_initBytes(QRCode *qrcoded, uint8_t *modules, uint8_t version, uint8_t ecc, uint8_t *data, uint16_t length);
78
79 bool qrcode_getModule(QRCode *qrcoded, uint8_t x, uint8_t y);
80
81#ifdef __cplusplus
82}
83#endif /* __cplusplus */
84
85#endif /* __QRCODE_H_ */
diff --git a/components/qrcode/qrcoded.c b/components/qrcode/qrcoded.c
new file mode 100755
index 0000000..c8825f3
--- /dev/null
+++ b/components/qrcode/qrcoded.c
@@ -0,0 +1,1054 @@
1/**
2 * The MIT License (MIT)
3 *
4 * This library is written and maintained by Richard Moore.
5 * Major parts were derived from Project Nayuki's library.
6 *
7 * Copyright (c) 2017 Richard Moore (https://github.com/ricmoo/QRCode)
8 * Copyright (c) 2017 Project Nayuki (https://www.nayuki.io/page/qr-code-generator-library)
9 *
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
16 *
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
26 * THE SOFTWARE.
27 */
28
29/**
30 * Special thanks to Nayuki (https://www.nayuki.io/) from which this library was
31 * heavily inspired and compared against.
32 *
33 * See: https://github.com/nayuki/QR-Code-generator/tree/master/cpp
34 */
35
36#include "qrcoded.h"
37
38#include <stdlib.h>
39#include <string.h>
40
41/* Error Correction Lookup tables */
42
43#if LOCK_VERSION == 0
44
45static const uint16_t NUM_ERROR_CORRECTION_CODEWORDS[4][40] = {
46 // 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 Error correction level
47 {10, 16, 26, 36, 48, 64, 72, 88, 110, 130, 150, 176, 198, 216, 240, 280, 308, 338, 364, 416, 442, 476, 504, 560, 588, 644, 700, 728, 784, 812, 868, 924, 980, 1036, 1064, 1120, 1204, 1260, 1316, 1372}, // Medium
48 {7, 10, 15, 20, 26, 36, 40, 48, 60, 72, 80, 96, 104, 120, 132, 144, 168, 180, 196, 224, 224, 252, 270, 300, 312, 336, 360, 390, 420, 450, 480, 510, 540, 570, 570, 600, 630, 660, 720, 750}, // Low
49 {17, 28, 44, 64, 88, 112, 130, 156, 192, 224, 264, 308, 352, 384, 432, 480, 532, 588, 650, 700, 750, 816, 900, 960, 1050, 1110, 1200, 1260, 1350, 1440, 1530, 1620, 1710, 1800, 1890, 1980, 2100, 2220, 2310, 2430}, // High
50 {13, 22, 36, 52, 72, 96, 108, 132, 160, 192, 224, 260, 288, 320, 360, 408, 448, 504, 546, 600, 644, 690, 750, 810, 870, 952, 1020, 1050, 1140, 1200, 1290, 1350, 1440, 1530, 1590, 1680, 1770, 1860, 1950, 2040}, // Quartile
51};
52
53static const uint8_t NUM_ERROR_CORRECTION_BLOCKS[4][40] = {
54 // Version: (note that index 0 is for padding, and is set to an illegal value)
55 // 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 Error correction level
56 {1, 1, 1, 2, 2, 4, 4, 4, 5, 5, 5, 8, 9, 9, 10, 10, 11, 13, 14, 16, 17, 17, 18, 20, 21, 23, 25, 26, 28, 29, 31, 33, 35, 37, 38, 40, 43, 45, 47, 49}, // Medium
57 {1, 1, 1, 1, 1, 2, 2, 2, 2, 4, 4, 4, 4, 4, 6, 6, 6, 6, 7, 8, 8, 9, 9, 10, 12, 12, 12, 13, 14, 15, 16, 17, 18, 19, 19, 20, 21, 22, 24, 25}, // Low
58 {1, 1, 2, 4, 4, 4, 5, 6, 8, 8, 11, 11, 16, 16, 18, 16, 19, 21, 25, 25, 25, 34, 30, 32, 35, 37, 40, 42, 45, 48, 51, 54, 57, 60, 63, 66, 70, 74, 77, 81}, // High
59 {1, 1, 2, 2, 4, 4, 6, 6, 8, 8, 8, 10, 12, 16, 12, 17, 16, 18, 21, 20, 23, 23, 25, 27, 29, 34, 34, 35, 38, 40, 43, 45, 48, 51, 53, 56, 59, 62, 65, 68}, // Quartile
60};
61
62static const uint16_t NUM_RAW_DATA_MODULES[40] = {
63 // 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17,
64 208, 359, 567, 807, 1079, 1383, 1568, 1936, 2336, 2768, 3232, 3728, 4256, 4651, 5243, 5867, 6523,
65 // 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31,
66 7211, 7931, 8683, 9252, 10068, 10916, 11796, 12708, 13652, 14628, 15371, 16411, 17483, 18587,
67 // 32, 33, 34, 35, 36, 37, 38, 39, 40
68 19723, 20891, 22091, 23008, 24272, 25568, 26896, 28256, 29648};
69
70// @TODO: Put other LOCK_VERSIONS here
71#elif LOCK_VERSION == 3
72
73static const int16_t NUM_ERROR_CORRECTION_CODEWORDS[4] = {
74 26, 15, 44, 36};
75
76static const int8_t NUM_ERROR_CORRECTION_BLOCKS[4] = {
77 1, 1, 2, 2};
78
79static const uint16_t NUM_RAW_DATA_MODULES = 567;
80
81#else
82
83#error Unsupported LOCK_VERSION (add it...)
84
85#endif
86
87static int max(int a, int b)
88{
89 if (a > b)
90 {
91 return a;
92 }
93 return b;
94}
95
96/*
97static int abs(int value) {
98 if (value < 0) { return -value; }
99 return value;
100}
101*/
102
103/* Mode testing and conversion */
104
105static int8_t getAlphanumeric(char c)
106{
107
108 if (c >= '0' && c <= '9')
109 {
110 return (c - '0');
111 }
112 if (c >= 'A' && c <= 'Z')
113 {
114 return (c - 'A' + 10);
115 }
116
117 switch (c)
118 {
119 case ' ':
120 return 36;
121 case '$':
122 return 37;
123 case '%':
124 return 38;
125 case '*':
126 return 39;
127 case '+':
128 return 40;
129 case '-':
130 return 41;
131 case '.':
132 return 42;
133 case '/':
134 return 43;
135 case ':':
136 return 44;
137 }
138
139 return -1;
140}
141
142static bool isAlphanumeric(const char *text, uint16_t length)
143{
144 while (length != 0)
145 {
146 if (getAlphanumeric(text[--length]) == -1)
147 {
148 return false;
149 }
150 }
151 return true;
152}
153
154static bool isNumeric(const char *text, uint16_t length)
155{
156 while (length != 0)
157 {
158 char c = text[--length];
159 if (c < '0' || c > '9')
160 {
161 return false;
162 }
163 }
164 return true;
165}
166
167/* Counting */
168
169// We store the following tightly packed (less 8) in modeInfo
170// <=9 <=26 <= 40
171// NUMERIC ( 10, 12, 14);
172// ALPHANUMERIC ( 9, 11, 13);
173// BYTE ( 8, 16, 16);
174static char getModeBits(uint8_t version, uint8_t mode)
175{
176 // Note: We use 15 instead of 16; since 15 doesn't exist and we cannot store 16 (8 + 8) in 3 bits
177 // hex(int("".join(reversed([('00' + bin(x - 8)[2:])[-3:] for x in [10, 9, 8, 12, 11, 15, 14, 13, 15]])), 2))
178 unsigned int modeInfo = 0x7bbb80a;
179
180#if LOCK_VERSION == 0 || LOCK_VERSION > 9
181 if (version > 9)
182 {
183 modeInfo >>= 9;
184 }
185#endif
186
187#if LOCK_VERSION == 0 || LOCK_VERSION > 26
188 if (version > 26)
189 {
190 modeInfo >>= 9;
191 }
192#endif
193
194 char result = 8 + ((modeInfo >> (3 * mode)) & 0x07);
195 if (result == 15)
196 {
197 result = 16;
198 }
199
200 return result;
201}
202
203/* BitBucket */
204
205typedef struct BitBucket
206{
207 uint32_t bitOffsetOrWidth;
208 uint16_t capacityBytes;
209 uint8_t *data;
210} BitBucket;
211
212/*
213void bb_dump(BitBucket *bitBuffer) {
214 printf("Buffer: ");
215 for (uint32_t i = 0; i < bitBuffer->capacityBytes; i++) {
216 printf("%02x", bitBuffer->data[i]);
217 if ((i % 4) == 3) { printf(" "); }
218 }
219 printf("\n");
220}
221*/
222
223static uint16_t bb_getGridSizeBytes(uint8_t size)
224{
225 return (((size * size) + 7) / 8);
226}
227
228static uint16_t bb_getBufferSizeBytes(uint32_t bits)
229{
230 return ((bits + 7) / 8);
231}
232
233static void bb_initBuffer(BitBucket *bitBuffer, uint8_t *data, int32_t capacityBytes)
234{
235 bitBuffer->bitOffsetOrWidth = 0;
236 bitBuffer->capacityBytes = capacityBytes;
237 bitBuffer->data = data;
238
239 memset(data, 0, bitBuffer->capacityBytes);
240}
241
242static void bb_initGrid(BitBucket *bitGrid, uint8_t *data, uint8_t size)
243{
244 bitGrid->bitOffsetOrWidth = size;
245 bitGrid->capacityBytes = bb_getGridSizeBytes(size);
246 bitGrid->data = data;
247
248 memset(data, 0, bitGrid->capacityBytes);
249}
250
251static void bb_appendBits(BitBucket *bitBuffer, uint32_t val, uint8_t length)
252{
253 uint32_t offset = bitBuffer->bitOffsetOrWidth;
254 for (int8_t i = length - 1; i >= 0; i--, offset++)
255 {
256 bitBuffer->data[offset >> 3] |= ((val >> i) & 1) << (7 - (offset & 7));
257 }
258 bitBuffer->bitOffsetOrWidth = offset;
259}
260/*
261void bb_setBits(BitBucket *bitBuffer, uint32_t val, int offset, uint8_t length) {
262 for (int8_t i = length - 1; i >= 0; i--, offset++) {
263 bitBuffer->data[offset >> 3] |= ((val >> i) & 1) << (7 - (offset & 7));
264 }
265}
266*/
267static void bb_setBit(BitBucket *bitGrid, uint8_t x, uint8_t y, bool on)
268{
269 uint32_t offset = y * bitGrid->bitOffsetOrWidth + x;
270 uint8_t mask = 1 << (7 - (offset & 0x07));
271 if (on)
272 {
273 bitGrid->data[offset >> 3] |= mask;
274 }
275 else
276 {
277 bitGrid->data[offset >> 3] &= ~mask;
278 }
279}
280
281static void bb_invertBit(BitBucket *bitGrid, uint8_t x, uint8_t y, bool invert)
282{
283 uint32_t offset = y * bitGrid->bitOffsetOrWidth + x;
284 uint8_t mask = 1 << (7 - (offset & 0x07));
285 bool on = ((bitGrid->data[offset >> 3] & (1 << (7 - (offset & 0x07)))) != 0);
286 if (on ^ invert)
287 {
288 bitGrid->data[offset >> 3] |= mask;
289 }
290 else
291 {
292 bitGrid->data[offset >> 3] &= ~mask;
293 }
294}
295
296static bool bb_getBit(BitBucket *bitGrid, uint8_t x, uint8_t y)
297{
298 uint32_t offset = y * bitGrid->bitOffsetOrWidth + x;
299 return (bitGrid->data[offset >> 3] & (1 << (7 - (offset & 0x07)))) != 0;
300}
301
302/* Drawing Patterns */
303
304// XORs the data modules in this QR Code with the given mask pattern. Due to XOR's mathematical
305// properties, calling applyMask(m) twice with the same value is equivalent to no change at all.
306// This means it is possible to apply a mask, undo it, and try another mask. Note that a final
307// well-formed QR Code symbol needs exactly one mask applied (not zero, not two, etc.).
308static void applyMask(BitBucket *modules, BitBucket *isFunction, uint8_t mask)
309{
310 uint8_t size = modules->bitOffsetOrWidth;
311
312 for (uint8_t y = 0; y < size; y++)
313 {
314 for (uint8_t x = 0; x < size; x++)
315 {
316 if (bb_getBit(isFunction, x, y))
317 {
318 continue;
319 }
320
321 bool invert = 0;
322 switch (mask)
323 {
324 case 0:
325 invert = (x + y) % 2 == 0;
326 break;
327 case 1:
328 invert = y % 2 == 0;
329 break;
330 case 2:
331 invert = x % 3 == 0;
332 break;
333 case 3:
334 invert = (x + y) % 3 == 0;
335 break;
336 case 4:
337 invert = (x / 3 + y / 2) % 2 == 0;
338 break;
339 case 5:
340 invert = x * y % 2 + x * y % 3 == 0;
341 break;
342 case 6:
343 invert = (x * y % 2 + x * y % 3) % 2 == 0;
344 break;
345 case 7:
346 invert = ((x + y) % 2 + x * y % 3) % 2 == 0;
347 break;
348 }
349 bb_invertBit(modules, x, y, invert);
350 }
351 }
352}
353
354static void setFunctionModule(BitBucket *modules, BitBucket *isFunction, uint8_t x, uint8_t y, bool on)
355{
356 bb_setBit(modules, x, y, on);
357 bb_setBit(isFunction, x, y, true);
358}
359
360// Draws a 9*9 finder pattern including the border separator, with the center module at (x, y).
361static void drawFinderPattern(BitBucket *modules, BitBucket *isFunction, uint8_t x, uint8_t y)
362{
363 uint8_t size = modules->bitOffsetOrWidth;
364
365 for (int8_t i = -4; i <= 4; i++)
366 {
367 for (int8_t j = -4; j <= 4; j++)
368 {
369 uint8_t dist = max(abs(i), abs(j)); // Chebyshev/infinity norm
370 int16_t xx = x + j, yy = y + i;
371 if (0 <= xx && xx < size && 0 <= yy && yy < size)
372 {
373 setFunctionModule(modules, isFunction, xx, yy, dist != 2 && dist != 4);
374 }
375 }
376 }
377}
378
379// Draws a 5*5 alignment pattern, with the center module at (x, y).
380static void drawAlignmentPattern(BitBucket *modules, BitBucket *isFunction, uint8_t x, uint8_t y)
381{
382 for (int8_t i = -2; i <= 2; i++)
383 {
384 for (int8_t j = -2; j <= 2; j++)
385 {
386 setFunctionModule(modules, isFunction, x + j, y + i, max(abs(i), abs(j)) != 1);
387 }
388 }
389}
390
391// Draws two copies of the format bits (with its own error correction code)
392// based on the given mask and this object's error correction level field.
393static void drawFormatBits(BitBucket *modules, BitBucket *isFunction, uint8_t ecc, uint8_t mask)
394{
395
396 uint8_t size = modules->bitOffsetOrWidth;
397
398 // Calculate error correction code and pack bits
399 uint32_t data = ecc << 3 | mask; // errCorrLvl is uint2, mask is uint3
400 uint32_t rem = data;
401 for (int i = 0; i < 10; i++)
402 {
403 rem = (rem << 1) ^ ((rem >> 9) * 0x537);
404 }
405
406 data = data << 10 | rem;
407 data ^= 0x5412; // uint15
408
409 // Draw first copy
410 for (uint8_t i = 0; i <= 5; i++)
411 {
412 setFunctionModule(modules, isFunction, 8, i, ((data >> i) & 1) != 0);
413 }
414
415 setFunctionModule(modules, isFunction, 8, 7, ((data >> 6) & 1) != 0);
416 setFunctionModule(modules, isFunction, 8, 8, ((data >> 7) & 1) != 0);
417 setFunctionModule(modules, isFunction, 7, 8, ((data >> 8) & 1) != 0);
418
419 for (int8_t i = 9; i < 15; i++)
420 {
421 setFunctionModule(modules, isFunction, 14 - i, 8, ((data >> i) & 1) != 0);
422 }
423
424 // Draw second copy
425 for (int8_t i = 0; i <= 7; i++)
426 {
427 setFunctionModule(modules, isFunction, size - 1 - i, 8, ((data >> i) & 1) != 0);
428 }
429
430 for (int8_t i = 8; i < 15; i++)
431 {
432 setFunctionModule(modules, isFunction, 8, size - 15 + i, ((data >> i) & 1) != 0);
433 }
434
435 setFunctionModule(modules, isFunction, 8, size - 8, true);
436}
437
438// Draws two copies of the version bits (with its own error correction code),
439// based on this object's version field (which only has an effect for 7 <= version <= 40).
440static void drawVersion(BitBucket *modules, BitBucket *isFunction, uint8_t version)
441{
442
443 int8_t size = modules->bitOffsetOrWidth;
444
445#if LOCK_VERSION != 0 && LOCK_VERSION < 7
446 return;
447
448#else
449 if (version < 7)
450 {
451 return;
452 }
453
454 // Calculate error correction code and pack bits
455 uint32_t rem = version; // version is uint6, in the range [7, 40]
456 for (uint8_t i = 0; i < 12; i++)
457 {
458 rem = (rem << 1) ^ ((rem >> 11) * 0x1F25);
459 }
460
461 uint32_t data = version << 12 | rem; // uint18
462
463 // Draw two copies
464 for (uint8_t i = 0; i < 18; i++)
465 {
466 bool bit = ((data >> i) & 1) != 0;
467 uint8_t a = size - 11 + i % 3, b = i / 3;
468 setFunctionModule(modules, isFunction, a, b, bit);
469 setFunctionModule(modules, isFunction, b, a, bit);
470 }
471
472#endif
473}
474
475static void drawFunctionPatterns(BitBucket *modules, BitBucket *isFunction, uint8_t version, uint8_t ecc)
476{
477
478 uint8_t size = modules->bitOffsetOrWidth;
479
480 // Draw the horizontal and vertical timing patterns
481 for (uint8_t i = 0; i < size; i++)
482 {
483 setFunctionModule(modules, isFunction, 6, i, i % 2 == 0);
484 setFunctionModule(modules, isFunction, i, 6, i % 2 == 0);
485 }
486
487 // Draw 3 finder patterns (all corners except bottom right; overwrites some timing modules)
488 drawFinderPattern(modules, isFunction, 3, 3);
489 drawFinderPattern(modules, isFunction, size - 4, 3);
490 drawFinderPattern(modules, isFunction, 3, size - 4);
491
492#if LOCK_VERSION == 0 || LOCK_VERSION > 1
493
494 if (version > 1)
495 {
496
497 // Draw the numerous alignment patterns
498
499 uint8_t alignCount = version / 7 + 2;
500 uint8_t step;
501 if (version != 32)
502 {
503 step = (version * 4 + alignCount * 2 + 1) / (2 * alignCount - 2) * 2; // ceil((size - 13) / (2*numAlign - 2)) * 2
504 }
505 else
506 { // C-C-C-Combo breaker!
507 step = 26;
508 }
509
510 uint8_t alignPositionIndex = alignCount - 1;
511 uint8_t alignPosition[alignCount];
512
513 alignPosition[0] = 6;
514
515 uint8_t size = version * 4 + 17;
516 for (uint8_t i = 0, pos = size - 7; i < alignCount - 1; i++, pos -= step)
517 {
518 alignPosition[alignPositionIndex--] = pos;
519 }
520
521 for (uint8_t i = 0; i < alignCount; i++)
522 {
523 for (uint8_t j = 0; j < alignCount; j++)
524 {
525 if ((i == 0 && j == 0) || (i == 0 && j == alignCount - 1) || (i == alignCount - 1 && j == 0))
526 {
527 continue; // Skip the three finder corners
528 }
529 else
530 {
531 drawAlignmentPattern(modules, isFunction, alignPosition[i], alignPosition[j]);
532 }
533 }
534 }
535 }
536
537#endif
538
539 // Draw configuration data
540 drawFormatBits(modules, isFunction, ecc, 0); // Dummy mask value; overwritten later in the constructor
541 drawVersion(modules, isFunction, version);
542}
543
544// Draws the given sequence of 8-bit codewords (data and error correction) onto the entire
545// data area of this QR Code symbol. Function modules need to be marked off before this is called.
546static void drawCodewords(BitBucket *modules, BitBucket *isFunction, BitBucket *codewords)
547{
548
549 uint32_t bitLength = codewords->bitOffsetOrWidth;
550 uint8_t *data = codewords->data;
551
552 uint8_t size = modules->bitOffsetOrWidth;
553
554 // Bit index into the data
555 uint32_t i = 0;
556
557 // Do the funny zigzag scan
558 for (int16_t right = size - 1; right >= 1; right -= 2)
559 { // Index of right column in each column pair
560 if (right == 6)
561 {
562 right = 5;
563 }
564
565 for (uint8_t vert = 0; vert < size; vert++)
566 { // Vertical counter
567 for (int j = 0; j < 2; j++)
568 {
569 uint8_t x = right - j; // Actual x coordinate
570 bool upwards = ((right & 2) == 0) ^ (x < 6);
571 uint8_t y = upwards ? size - 1 - vert : vert; // Actual y coordinate
572 if (!bb_getBit(isFunction, x, y) && i < bitLength)
573 {
574 bb_setBit(modules, x, y, ((data[i >> 3] >> (7 - (i & 7))) & 1) != 0);
575 i++;
576 }
577 // If there are any remainder bits (0 to 7), they are already
578 // set to 0/false/white when the grid of modules was initialized
579 }
580 }
581 }
582}
583
584/* Penalty Calculation */
585
586#define PENALTY_N1 3
587#define PENALTY_N2 3
588#define PENALTY_N3 40
589#define PENALTY_N4 10
590
591// Calculates and returns the penalty score based on state of this QR Code's current modules.
592// This is used by the automatic mask choice algorithm to find the mask pattern that yields the lowest score.
593// @TODO: This can be optimized by working with the bytes instead of bits.
594static uint32_t getPenaltyScore(BitBucket *modules)
595{
596 uint32_t result = 0;
597
598 uint8_t size = modules->bitOffsetOrWidth;
599
600 // Adjacent modules in row having same color
601 for (uint8_t y = 0; y < size; y++)
602 {
603
604 bool colorX = bb_getBit(modules, 0, y);
605 for (uint8_t x = 1, runX = 1; x < size; x++)
606 {
607 bool cx = bb_getBit(modules, x, y);
608 if (cx != colorX)
609 {
610 colorX = cx;
611 runX = 1;
612 }
613 else
614 {
615 runX++;
616 if (runX == 5)
617 {
618 result += PENALTY_N1;
619 }
620 else if (runX > 5)
621 {
622 result++;
623 }
624 }
625 }
626 }
627
628 // Adjacent modules in column having same color
629 for (uint8_t x = 0; x < size; x++)
630 {
631 bool colorY = bb_getBit(modules, x, 0);
632 for (uint8_t y = 1, runY = 1; y < size; y++)
633 {
634 bool cy = bb_getBit(modules, x, y);
635 if (cy != colorY)
636 {
637 colorY = cy;
638 runY = 1;
639 }
640 else
641 {
642 runY++;
643 if (runY == 5)
644 {
645 result += PENALTY_N1;
646 }
647 else if (runY > 5)
648 {
649 result++;
650 }
651 }
652 }
653 }
654
655 uint16_t black = 0;
656 for (uint8_t y = 0; y < size; y++)
657 {
658 uint16_t bitsRow = 0, bitsCol = 0;
659 for (uint8_t x = 0; x < size; x++)
660 {
661 bool color = bb_getBit(modules, x, y);
662
663 // 2*2 blocks of modules having same color
664 if (x > 0 && y > 0)
665 {
666 bool colorUL = bb_getBit(modules, x - 1, y - 1);
667 bool colorUR = bb_getBit(modules, x, y - 1);
668 bool colorL = bb_getBit(modules, x - 1, y);
669 if (color == colorUL && color == colorUR && color == colorL)
670 {
671 result += PENALTY_N2;
672 }
673 }
674
675 // Finder-like pattern in rows and columns
676 bitsRow = ((bitsRow << 1) & 0x7FF) | color;
677 bitsCol = ((bitsCol << 1) & 0x7FF) | bb_getBit(modules, y, x);
678
679 // Needs 11 bits accumulated
680 if (x >= 10)
681 {
682 if (bitsRow == 0x05D || bitsRow == 0x5D0)
683 {
684 result += PENALTY_N3;
685 }
686 if (bitsCol == 0x05D || bitsCol == 0x5D0)
687 {
688 result += PENALTY_N3;
689 }
690 }
691
692 // Balance of black and white modules
693 if (color)
694 {
695 black++;
696 }
697 }
698 }
699
700 // Find smallest k such that (45-5k)% <= dark/total <= (55+5k)%
701 uint16_t total = size * size;
702 for (uint16_t k = 0; black * 20 < (9 - k) * total || black * 20 > (11 + k) * total; k++)
703 {
704 result += PENALTY_N4;
705 }
706
707 return result;
708}
709
710/* Reed-Solomon Generator */
711
712static uint8_t rs_multiply(uint8_t x, uint8_t y)
713{
714 // Russian peasant multiplication
715 // See: https://en.wikipedia.org/wiki/Ancient_Egyptian_multiplication
716 uint16_t z = 0;
717 for (int8_t i = 7; i >= 0; i--)
718 {
719 z = (z << 1) ^ ((z >> 7) * 0x11D);
720 z ^= ((y >> i) & 1) * x;
721 }
722 return z;
723}
724
725static void rs_init(uint8_t degree, uint8_t *coeff)
726{
727 memset(coeff, 0, degree);
728 coeff[degree - 1] = 1;
729
730 // Compute the product polynomial (x - r^0) * (x - r^1) * (x - r^2) * ... * (x - r^{degree-1}),
731 // drop the highest term, and store the rest of the coefficients in order of descending powers.
732 // Note that r = 0x02, which is a generator element of this field GF(2^8/0x11D).
733 uint16_t root = 1;
734 for (uint8_t i = 0; i < degree; i++)
735 {
736 // Multiply the current product by (x - r^i)
737 for (uint8_t j = 0; j < degree; j++)
738 {
739 coeff[j] = rs_multiply(coeff[j], root);
740 if (j + 1 < degree)
741 {
742 coeff[j] ^= coeff[j + 1];
743 }
744 }
745 root = (root << 1) ^ ((root >> 7) * 0x11D); // Multiply by 0x02 mod GF(2^8/0x11D)
746 }
747}
748
749static void rs_getRemainder(uint8_t degree, uint8_t *coeff, uint8_t *data, uint8_t length, uint8_t *result, uint8_t stride)
750{
751 // Compute the remainder by performing polynomial division
752
753 //for (uint8_t i = 0; i < degree; i++) { result[] = 0; }
754 //memset(result, 0, degree);
755
756 for (uint8_t i = 0; i < length; i++)
757 {
758 uint8_t factor = data[i] ^ result[0];
759 for (uint8_t j = 1; j < degree; j++)
760 {
761 result[(j - 1) * stride] = result[j * stride];
762 }
763 result[(degree - 1) * stride] = 0;
764
765 for (uint8_t j = 0; j < degree; j++)
766 {
767 result[j * stride] ^= rs_multiply(coeff[j], factor);
768 }
769 }
770}
771
772/* QrCode */
773
774static int8_t encodeDataCodewords(BitBucket *dataCodewords, const uint8_t *text, uint16_t length, uint8_t version)
775{
776 int8_t mode = MODE_BYTE;
777
778 if (isNumeric((char *)text, length))
779 {
780 mode = MODE_NUMERIC;
781 bb_appendBits(dataCodewords, 1 << MODE_NUMERIC, 4);
782 bb_appendBits(dataCodewords, length, getModeBits(version, MODE_NUMERIC));
783
784 uint16_t accumData = 0;
785 uint8_t accumCount = 0;
786 for (uint16_t i = 0; i < length; i++)
787 {
788 accumData = accumData * 10 + ((char)(text[i]) - '0');
789 accumCount++;
790 if (accumCount == 3)
791 {
792 bb_appendBits(dataCodewords, accumData, 10);
793 accumData = 0;
794 accumCount = 0;
795 }
796 }
797
798 // 1 or 2 digits remaining
799 if (accumCount > 0)
800 {
801 bb_appendBits(dataCodewords, accumData, accumCount * 3 + 1);
802 }
803 }
804 else if (isAlphanumeric((char *)text, length))
805 {
806 mode = MODE_ALPHANUMERIC;
807 bb_appendBits(dataCodewords, 1 << MODE_ALPHANUMERIC, 4);
808 bb_appendBits(dataCodewords, length, getModeBits(version, MODE_ALPHANUMERIC));
809
810 uint16_t accumData = 0;
811 uint8_t accumCount = 0;
812 for (uint16_t i = 0; i < length; i++)
813 {
814 accumData = accumData * 45 + getAlphanumeric((char)(text[i]));
815 accumCount++;
816 if (accumCount == 2)
817 {
818 bb_appendBits(dataCodewords, accumData, 11);
819 accumData = 0;
820 accumCount = 0;
821 }
822 }
823
824 // 1 character remaining
825 if (accumCount > 0)
826 {
827 bb_appendBits(dataCodewords, accumData, 6);
828 }
829 }
830 else
831 {
832 bb_appendBits(dataCodewords, 1 << MODE_BYTE, 4);
833 bb_appendBits(dataCodewords, length, getModeBits(version, MODE_BYTE));
834 for (uint16_t i = 0; i < length; i++)
835 {
836 bb_appendBits(dataCodewords, (char)(text[i]), 8);
837 }
838 }
839
840 //bb_setBits(dataCodewords, length, 4, getModeBits(version, mode));
841
842 return mode;
843}
844
845static void performErrorCorrection(uint8_t version, uint8_t ecc, BitBucket *data)
846{
847
848 // See: http://www.thonky.com/qr-code-tutorial/structure-final-message
849
850#if LOCK_VERSION == 0
851 uint8_t numBlocks = NUM_ERROR_CORRECTION_BLOCKS[ecc][version - 1];
852 uint16_t totalEcc = NUM_ERROR_CORRECTION_CODEWORDS[ecc][version - 1];
853 uint16_t moduleCount = NUM_RAW_DATA_MODULES[version - 1];
854#else
855 uint8_t numBlocks = NUM_ERROR_CORRECTION_BLOCKS[ecc];
856 uint16_t totalEcc = NUM_ERROR_CORRECTION_CODEWORDS[ecc];
857 uint16_t moduleCount = NUM_RAW_DATA_MODULES;
858#endif
859
860 uint8_t blockEccLen = totalEcc / numBlocks;
861 uint8_t numShortBlocks = numBlocks - moduleCount / 8 % numBlocks;
862 uint8_t shortBlockLen = moduleCount / 8 / numBlocks;
863
864 uint8_t shortDataBlockLen = shortBlockLen - blockEccLen;
865
866 uint8_t result[data->capacityBytes];
867 memset(result, 0, sizeof(result));
868
869 uint8_t coeff[blockEccLen];
870 rs_init(blockEccLen, coeff);
871
872 uint16_t offset = 0;
873 uint8_t *dataBytes = data->data;
874
875 // Interleave all short blocks
876 for (uint8_t i = 0; i < shortDataBlockLen; i++)
877 {
878 uint16_t index = i;
879 uint8_t stride = shortDataBlockLen;
880 for (uint8_t blockNum = 0; blockNum < numBlocks; blockNum++)
881 {
882 result[offset++] = dataBytes[index];
883
884#if LOCK_VERSION == 0 || LOCK_VERSION >= 5
885 if (blockNum == numShortBlocks)
886 {
887 stride++;
888 }
889#endif
890 index += stride;
891 }
892 }
893
894 // Version less than 5 only have short blocks
895#if LOCK_VERSION == 0 || LOCK_VERSION >= 5
896 {
897 // Interleave long blocks
898 uint16_t index = shortDataBlockLen * (numShortBlocks + 1);
899 uint8_t stride = shortDataBlockLen;
900 for (uint8_t blockNum = 0; blockNum < numBlocks - numShortBlocks; blockNum++)
901 {
902 result[offset++] = dataBytes[index];
903
904 if (blockNum == 0)
905 {
906 stride++;
907 }
908 index += stride;
909 }
910 }
911#endif
912
913 // Add all ecc blocks, interleaved
914 uint8_t blockSize = shortDataBlockLen;
915 for (uint8_t blockNum = 0; blockNum < numBlocks; blockNum++)
916 {
917
918#if LOCK_VERSION == 0 || LOCK_VERSION >= 5
919 if (blockNum == numShortBlocks)
920 {
921 blockSize++;
922 }
923#endif
924 rs_getRemainder(blockEccLen, coeff, dataBytes, blockSize, &result[offset + blockNum], numBlocks);
925 dataBytes += blockSize;
926 }
927
928 memcpy(data->data, result, data->capacityBytes);
929 data->bitOffsetOrWidth = moduleCount;
930}
931
932// We store the Format bits tightly packed into a single byte (each of the 4 modes is 2 bits)
933// The format bits can be determined by ECC_FORMAT_BITS >> (2 * ecc)
934static const uint8_t ECC_FORMAT_BITS = (0x02 << 6) | (0x03 << 4) | (0x00 << 2) | (0x01 << 0);
935
936/* Public QRCode functions */
937
938uint16_t qrcode_getBufferSize(uint8_t version)
939{
940 return bb_getGridSizeBytes(4 * version + 17);
941}
942
943// @TODO: Return error if data is too big.
944int8_t qrcode_initBytes(QRCode *qrcoded, uint8_t *modules, uint8_t version, uint8_t ecc, uint8_t *data, uint16_t length)
945{
946 uint8_t size = version * 4 + 17;
947 qrcoded->version = version;
948 qrcoded->size = size;
949 qrcoded->ecc = ecc;
950 qrcoded->modules = modules;
951
952 uint8_t eccFormatBits = (ECC_FORMAT_BITS >> (2 * ecc)) & 0x03;
953
954#if LOCK_VERSION == 0
955 uint16_t moduleCount = NUM_RAW_DATA_MODULES[version - 1];
956 uint16_t dataCapacity = moduleCount / 8 - NUM_ERROR_CORRECTION_CODEWORDS[eccFormatBits][version - 1];
957#else
958 version = LOCK_VERSION;
959 uint16_t moduleCount = NUM_RAW_DATA_MODULES;
960 uint16_t dataCapacity = moduleCount / 8 - NUM_ERROR_CORRECTION_CODEWORDS[eccFormatBits];
961#endif
962
963 struct BitBucket codewords;
964 uint8_t codewordBytes[bb_getBufferSizeBytes(moduleCount)];
965 bb_initBuffer(&codewords, codewordBytes, (int32_t)sizeof(codewordBytes));
966
967 // Place the data code words into the buffer
968 int8_t mode = encodeDataCodewords(&codewords, data, length, version);
969
970 if (mode < 0)
971 {
972 return -1;
973 }
974 qrcoded->mode = mode;
975
976 // Add terminator and pad up to a byte if applicable
977 uint32_t padding = (dataCapacity * 8) - codewords.bitOffsetOrWidth;
978 if (padding > 4)
979 {
980 padding = 4;
981 }
982 bb_appendBits(&codewords, 0, padding);
983 bb_appendBits(&codewords, 0, (8 - codewords.bitOffsetOrWidth % 8) % 8);
984
985 // Pad with alternate bytes until data capacity is reached
986 for (uint8_t padByte = 0xEC; codewords.bitOffsetOrWidth < (dataCapacity * 8); padByte ^= 0xEC ^ 0x11)
987 {
988 bb_appendBits(&codewords, padByte, 8);
989 }
990
991 BitBucket modulesGrid;
992 bb_initGrid(&modulesGrid, modules, size);
993
994 BitBucket isFunctionGrid;
995 uint8_t isFunctionGridBytes[bb_getGridSizeBytes(size)];
996 bb_initGrid(&isFunctionGrid, isFunctionGridBytes, size);
997
998 // Draw function patterns, draw all codewords, do masking
999 drawFunctionPatterns(&modulesGrid, &isFunctionGrid, version, eccFormatBits);
1000 performErrorCorrection(version, eccFormatBits, &codewords);
1001 drawCodewords(&modulesGrid, &isFunctionGrid, &codewords);
1002
1003 // Find the best (lowest penalty) mask
1004 uint8_t mask = 0;
1005 int32_t minPenalty = INT32_MAX;
1006 for (uint8_t i = 0; i < 8; i++)
1007 {
1008 drawFormatBits(&modulesGrid, &isFunctionGrid, eccFormatBits, i);
1009 applyMask(&modulesGrid, &isFunctionGrid, i);
1010 int penalty = getPenaltyScore(&modulesGrid);
1011 if (penalty < minPenalty)
1012 {
1013 mask = i;
1014 minPenalty = penalty;
1015 }
1016 applyMask(&modulesGrid, &isFunctionGrid, i); // Undoes the mask due to XOR
1017 }
1018
1019 qrcoded->mask = mask;
1020
1021 // Overwrite old format bits
1022 drawFormatBits(&modulesGrid, &isFunctionGrid, eccFormatBits, mask);
1023
1024 // Apply the final choice of mask
1025 applyMask(&modulesGrid, &isFunctionGrid, mask);
1026
1027 return 0;
1028}
1029
1030int8_t qrcode_initText(QRCode *qrcoded, uint8_t *modules, uint8_t version, uint8_t ecc, const char *data)
1031{
1032 return qrcode_initBytes(qrcoded, modules, version, ecc, (uint8_t *)data, strlen(data));
1033}
1034
1035bool qrcode_getModule(QRCode *qrcoded, uint8_t x, uint8_t y)
1036{
1037 if (x >= qrcoded->size || y >= qrcoded->size)
1038 {
1039 return false;
1040 }
1041
1042 uint32_t offset = y * qrcoded->size + x;
1043 return (qrcoded->modules[offset >> 3] & (1 << (7 - (offset & 0x07)))) != 0;
1044}
1045
1046/*
1047uint8_t qrcode_getHexLength(QRCode *qrcoded) {
1048 return ((qrcoded->size * qrcoded->size) + 7) / 4;
1049}
1050
1051void qrcode_getHex(QRCode *qrcoded, char *result) {
1052
1053}
1054*/