Debian Codegraph @

lib/colorhug/ch-common.c

raw
1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
2 *
3 * Copyright (C) 2011-2013 Richard Hughes <[email protected]>
4 *
5 * Licensed under the GNU General Public License Version 2
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20 */
21
22 #include "config.h"
23
24 #include <glib.h>
25 #include <string.h>
26
27 #include "ch-common.h"
28
29 /**
30 * ch_strerror:
31 *
32 * Since: 0.1.29
33 **/
34 const gchar *
35 ch_strerror (ChError error_enum)
36 {
37 const char *str = NULL;
38 switch (error_enum) {
39 case CH_ERROR_NONE:
40 str = "Success";
41 break;
42 case CH_ERROR_UNKNOWN_CMD:
43 str = "Unknown command";
44 break;
45 case CH_ERROR_WRONG_UNLOCK_CODE:
46 str = "Wrong unlock code";
47 break;
48 case CH_ERROR_NOT_IMPLEMENTED:
49 str = "Not implemented";
50 break;
51 case CH_ERROR_UNDERFLOW_SENSOR:
52 str = "Underflow of sensor";
53 break;
54 case CH_ERROR_NO_SERIAL:
55 str = "No serial";
56 break;
57 case CH_ERROR_WATCHDOG:
58 str = "Watchdog";
59 break;
60 case CH_ERROR_INVALID_ADDRESS:
61 str = "Invalid address";
62 break;
63 case CH_ERROR_INVALID_LENGTH:
64 str = "Invalid length";
65 break;
66 case CH_ERROR_INVALID_CHECKSUM:
67 str = "Invalid checksum";
68 break;
69 case CH_ERROR_INVALID_VALUE:
70 str = "Invalid value";
71 break;
72 case CH_ERROR_UNKNOWN_CMD_FOR_BOOTLOADER:
73 str = "Unknown command for bootloader";
74 break;
75 case CH_ERROR_OVERFLOW_MULTIPLY:
76 str = "Overflow of multiply";
77 break;
78 case CH_ERROR_OVERFLOW_ADDITION:
79 str = "Overflow of addition";
80 break;
81 case CH_ERROR_OVERFLOW_SENSOR:
82 str = "Overflow of sensor";
83 break;
84 case CH_ERROR_OVERFLOW_STACK:
85 str = "Overflow of stack";
86 break;
87 case CH_ERROR_NO_CALIBRATION:
88 str = "No calibration";
89 break;
90 case CH_ERROR_DEVICE_DEACTIVATED:
91 str = "Device deactivated";
92 break;
93 case CH_ERROR_INCOMPLETE_REQUEST:
94 str = "Incomplete previous request";
95 break;
96 case CH_ERROR_SELF_TEST_SENSOR:
97 str = "Self test failed: Sensor";
98 break;
99 case CH_ERROR_SELF_TEST_RED:
100 str = "Self test failed: Red";
101 break;
102 case CH_ERROR_SELF_TEST_GREEN:
103 str = "Self test failed: Green";
104 break;
105 case CH_ERROR_SELF_TEST_BLUE:
106 str = "Self test failed: Blue";
107 break;
108 case CH_ERROR_SELF_TEST_MULTIPLIER:
109 str = "Self test failed: Multiplier";
110 break;
111 case CH_ERROR_SELF_TEST_COLOR_SELECT:
112 str = "Self test failed: Color Select";
113 break;
114 case CH_ERROR_SELF_TEST_TEMPERATURE:
115 str = "Self test failed: Temperature";
116 break;
117 case CH_ERROR_INVALID_CALIBRATION:
118 str = "Invalid calibration";
119 break;
120 case CH_ERROR_SRAM_FAILED:
121 str = "SRAM failed";
122 break;
123 case CH_ERROR_OUT_OF_MEMORY:
124 str = "Out of memory";
125 break;
126 case CH_ERROR_SELF_TEST_I2C:
127 str = "Self test failed: I2C";
128 break;
129 case CH_ERROR_SELF_TEST_ADC_VDD:
130 str = "Self test failed: ADC Vdd";
131 break;
132 case CH_ERROR_SELF_TEST_ADC_VSS:
133 str = "Self test failed: ADC Vss";
134 break;
135 case CH_ERROR_SELF_TEST_ADC_VREF:
136 str = "Self test failed: ADC Vref";
137 break;
138 case CH_ERROR_I2C_SLAVE_ADDRESS:
139 str = "I2C set slave address failed";
140 break;
141 case CH_ERROR_I2C_SLAVE_CONFIG:
142 str = "I2C set slave config failed";
143 break;
144 case CH_ERROR_SELF_TEST_EEPROM:
145 str = "Self test failed: EEPROM";
146 break;
147 default:
148 str = "Unknown error, please report";
149 break;
150 }
151 return str;
152 }
153
154 /**
155 * ch_color_select_to_string:
156 *
157 * Since: 0.1.29
158 **/
159 const gchar *
160 ch_color_select_to_string (ChColorSelect color_select)
161 {
162 const char *str = NULL;
163 switch (color_select) {
164 case CH_COLOR_SELECT_BLUE:
165 str = "Blue";
166 break;
167 case CH_COLOR_SELECT_RED:
168 str = "Red";
169 break;
170 case CH_COLOR_SELECT_GREEN:
171 str = "Green";
172 break;
173 case CH_COLOR_SELECT_WHITE:
174 str = "White";
175 break;
176 default:
177 str = "Unknown";
178 break;
179 }
180 return str;
181 }
182
183 /**
184 * ch_multiplier_to_string:
185 *
186 * Since: 0.1.29
187 **/
188 const gchar *
189 ch_multiplier_to_string (ChFreqScale multiplier)
190 {
191 const char *str = NULL;
192 switch (multiplier) {
193 case CH_FREQ_SCALE_0:
194 str = "0%";
195 break;
196 case CH_FREQ_SCALE_2:
197 str = "2%";
198 break;
199 case CH_FREQ_SCALE_20:
200 str = "20%";
201 break;
202 case CH_FREQ_SCALE_100:
203 str = "100%";
204 break;
205 default:
206 str = "Unknown%";
207 break;
208 }
209 return str;
210 }
211
212 /**
213 * ch_command_to_string:
214 *
215 * Since: 0.1.29
216 **/
217 const gchar *
218 ch_command_to_string (ChCmd cmd)
219 {
220 const char *str = NULL;
221 switch (cmd) {
222 case CH_CMD_GET_COLOR_SELECT:
223 str = "get-color-select";
224 break;
225 case CH_CMD_SET_COLOR_SELECT:
226 str = "set-color-select";
227 break;
228 case CH_CMD_GET_MULTIPLIER:
229 str = "get-multiplier";
230 break;
231 case CH_CMD_SET_MULTIPLIER:
232 str = "set-multiplier";
233 break;
234 case CH_CMD_GET_INTEGRAL_TIME:
235 str = "get-integral-time";
236 break;
237 case CH_CMD_SET_INTEGRAL_TIME:
238 str = "set-integral-time";
239 break;
240 case CH_CMD_GET_FIRMWARE_VERSION:
241 str = "get-firmare-version";
242 break;
243 case CH_CMD_GET_CALIBRATION:
244 str = "get-calibration";
245 break;
246 case CH_CMD_SET_CALIBRATION:
247 str = "set-calibration";
248 break;
249 case CH_CMD_GET_SERIAL_NUMBER:
250 str = "get-serial-number";
251 break;
252 case CH_CMD_SET_SERIAL_NUMBER:
253 str = "set-serial-number";
254 break;
255 case CH_CMD_GET_OWNER_NAME:
256 str = "get-owner-name";
257 break;
258 case CH_CMD_SET_OWNER_NAME:
259 str = "set-owner-name";
260 break;
261 case CH_CMD_GET_OWNER_EMAIL:
262 str = "get-owner-name";
263 break;
264 case CH_CMD_SET_OWNER_EMAIL:
265 str = "set-owner-email";
266 break;
267 case CH_CMD_GET_LEDS:
268 str = "get-leds";
269 break;
270 case CH_CMD_SET_LEDS:
271 str = "set-leds";
272 break;
273 case CH_CMD_GET_PCB_ERRATA:
274 str = "get-pcb-errata";
275 break;
276 case CH_CMD_SET_PCB_ERRATA:
277 str = "set-pcb-errata";
278 break;
279 case CH_CMD_GET_DARK_OFFSETS:
280 str = "get-dark-offsets";
281 break;
282 case CH_CMD_SET_DARK_OFFSETS:
283 str = "set-dark-offsets";
284 break;
285 case CH_CMD_WRITE_EEPROM:
286 str = "write-eeprom";
287 break;
288 case CH_CMD_TAKE_READING_RAW:
289 str = "take-reading-raw";
290 break;
291 case CH_CMD_TAKE_READINGS:
292 str = "take-readings";
293 break;
294 case CH_CMD_TAKE_READING_XYZ:
295 str = "take-reading-xyz";
296 break;
297 case CH_CMD_RESET:
298 str = "reset";
299 break;
300 case CH_CMD_READ_FLASH:
301 str = "read-flash";
302 break;
303 case CH_CMD_ERASE_FLASH:
304 str = "erase-flash";
305 break;
306 case CH_CMD_WRITE_FLASH:
307 str = "write-flash";
308 break;
309 case CH_CMD_BOOT_FLASH:
310 str = "boot-flash";
311 break;
312 case CH_CMD_SET_FLASH_SUCCESS:
313 str = "set-flash-success";
314 break;
315 case CH_CMD_GET_CALIBRATION_MAP:
316 str = "get-calibration-map";
317 break;
318 case CH_CMD_SET_CALIBRATION_MAP:
319 str = "set-calibration-map";
320 break;
321 case CH_CMD_GET_HARDWARE_VERSION:
322 str = "get-hardware-version";
323 break;
324 case CH_CMD_GET_REMOTE_HASH:
325 str = "get-remote-hash";
326 break;
327 case CH_CMD_SET_REMOTE_HASH:
328 str = "set-remote-hash";
329 break;
330 case CH_CMD_SELF_TEST:
331 str = "self-test";
332 break;
333 case CH_CMD_WRITE_SRAM:
334 str = "write-sram";
335 break;
336 case CH_CMD_READ_SRAM:
337 str = "read-sram";
338 break;
339 case CH_CMD_GET_MEASURE_MODE:
340 str = "get-measure-mode";
341 break;
342 case CH_CMD_SET_MEASURE_MODE:
343 str = "set-measure-mode";
344 break;
345 case CH_CMD_GET_TEMPERATURE:
346 str = "get-temperature";
347 break;
348 case CH_CMD_GET_ERROR:
349 str = "get-error";
350 break;
351 case CH_CMD_CLEAR_ERROR:
352 str = "clear-error";
353 break;
354 case CH_CMD_TAKE_READING_SPECTRAL:
355 str = "take-reading-spectral";
356 break;
357 case CH_CMD_GET_ADC_CALIBRATION_POS:
358 str = "get-adc-calibration-pos";
359 break;
360 case CH_CMD_GET_ADC_CALIBRATION_NEG:
361 str = "get-adc-calibration-neg";
362 break;
363 case CH_CMD_GET_CCD_CALIBRATION:
364 str = "get-ccd-calibration";
365 break;
366 case CH_CMD_SET_CCD_CALIBRATION:
367 str = "set-ccd-calibration";
368 break;
369 case CH_CMD_GET_ILLUMINANTS:
370 str = "get-illuminants";
371 break;
372 case CH_CMD_SET_ILLUMINANTS:
373 str = "set-illuminants";
374 break;
375 case CH_CMD_LOAD_SRAM:
376 str = "load-sram";
377 break;
378 case CH_CMD_SAVE_SRAM:
379 str = "save-sram";
380 break;
381 default:
382 str = "unknown-command";
383 break;
384 }
385 return str;
386 }
387
388 /**
389 * ch_measure_mode_to_string:
390 *
391 * Since: 0.1.29
392 **/
393 const gchar *
394 ch_measure_mode_to_string (ChMeasureMode measure_mode)
395 {
396 const char *str = NULL;
397 switch (measure_mode) {
398 case CH_MEASURE_MODE_FREQUENCY:
399 str = "frequency";
400 break;
401 case CH_MEASURE_MODE_DURATION:
402 str = "duration";
403 break;
404 default:
405 str = "unknown";
406 break;
407 }
408 return str;
409 }
410
411 /**
412 * ch_device_mode_to_string:
413 *
414 * Since: 0.1.29
415 **/
416 const gchar *
417 ch_device_mode_to_string (ChDeviceMode device_mode)
418 {
419 const char *str = NULL;
420 switch (device_mode) {
421 case CH_DEVICE_MODE_LEGACY:
422 str = "legacy";
423 break;
424 case CH_DEVICE_MODE_BOOTLOADER:
425 str = "bootloader";
426 break;
427 case CH_DEVICE_MODE_BOOTLOADER_PLUS:
428 str = "bootloader-plus";
429 break;
430 case CH_DEVICE_MODE_FIRMWARE:
431 str = "firmware";
432 break;
433 case CH_DEVICE_MODE_FIRMWARE_PLUS:
434 str = "firmware-plus";
435 break;
436 case CH_DEVICE_MODE_FIRMWARE2:
437 str = "firmware2";
438 break;
439 case CH_DEVICE_MODE_BOOTLOADER2:
440 str = "bootloader2";
441 break;
442 default:
443 str = "unknown";
444 break;
445 }
446 return str;
447 }
448
449 /**
450 * ch_device_mode_from_firmware:
451 * @data: (array length=data_len): firmware binary data
452 * @data_len: size of @data
453 *
454 * Gets the device mode from the unique code stored in the firmware data.
455 * The firmware identifier has been present since colorhug-1.2.2.bin for
456 * ColorHug and all firmware versions for ColorHug2 and ColorHug+.
457 *
458 * Return value: A #ChDeviceMode
459 *
460 * Since: 1.2.3
461 **/
462 ChDeviceMode
463 ch_device_mode_from_firmware (const guint8 *data, gsize data_len)
464 {
465 gsize i;
466 for (i = 0; i < data_len - 8; i++) {
467 if (memcmp (data + i, CH_FIRMWARE_ID_TOKEN1, 8) == 0)
468 return CH_DEVICE_MODE_FIRMWARE;
469 if (memcmp (data + i, CH_FIRMWARE_ID_TOKEN2, 8) == 0)
470 return CH_DEVICE_MODE_FIRMWARE2;
471 if (memcmp (data + i, CH_FIRMWARE_ID_TOKEN_PLUS, 8) == 0)
472 return CH_DEVICE_MODE_FIRMWARE_PLUS;
473 if (memcmp (data + i, CH_FIRMWARE_ID_TOKEN_ALS, 8) == 0)
474 return CH_DEVICE_MODE_FIRMWARE_ALS;
475 }
476 return CH_DEVICE_MODE_UNKNOWN;
477 }