epicardium.h 16.2 KB
Newer Older
Rahix's avatar
Rahix committed
1
2
#ifndef _EPICARDIUM_H
#define _EPICARDIUM_H
Rahix's avatar
Rahix committed
3

Rahix's avatar
Rahix committed
4
#include <stdint.h>
5
#include <errno.h>
Rahix's avatar
Rahix committed
6

Rahix's avatar
Rahix committed
7
8
9
10
11
12
13
14
15
16
#ifndef __SPHINX_DOC
/* stddef.h is not recognized by hawkmoth for some odd reason */
#include <stddef.h>
#else
typedef unsigned int size_t;
#endif /* __SPHINX_DOC */

/*
 * These definitions are required for the code-generator.  Please don't touch!
 */
Rahix's avatar
Rahix committed
17
#ifndef API
Rahix's avatar
Rahix committed
18
#define API(id, def) def
Rahix's avatar
Rahix committed
19
#endif
20
21
22
#ifndef API_ISR
#define API_ISR(id, isr) void isr(void);
#endif
Rahix's avatar
Rahix committed
23

24
25
26
27
28
29
/*
 * IDs for all defined API calls.  These IDs should not be needed in application
 * code on any side.
 */

/* clang-format off */
Rahix's avatar
Rahix committed
30
31
32
#define API_UART_WRITE         0x1
#define API_UART_READ          0x2
#define API_LEDS_SET           0x3
Rahix's avatar
Rahix committed
33
#define API_VIBRA_SET          0x4
34
#define API_VIBRA_VIBRATE      0x5
35
#define API_STREAM_READ        0x6
36
37
#define API_INTERRUPT_ENABLE   0x7
#define API_INTERRUPT_DISABLE  0x8
38
39
40
#define API_LIGHT_SENSOR_RUN   0x9
#define API_LIGHT_SENSOR_GET   0xa
#define API_LIGHT_SENSOR_STOP  0xb
41

Gerd's avatar
Gerd committed
42
43
44
45
46
47
48
49
#define API_DISP_OPEN          0x10
#define API_DISP_CLOSE         0x11
#define API_DISP_PRINT         0x12
#define API_DISP_CLEAR         0x13
#define API_DISP_UPDATE        0x14
#define API_DISP_LINE          0x15
#define API_DISP_RECT          0x16
#define API_DISP_CIRC          0x17
50
#define API_DISP_PIXEL         0x18
51
#define API_DISP_FRAMEBUFFER   0x19
52
53
54
55
56
57

#define API_FILE_OPEN          0x30
#define API_FILE_CLOSE         0x31
#define API_FILE_READ          0x32
#define API_FILE_WRITE         0x34
#define API_FILE_FLUSH         0x35
58
59
#define API_FILE_SEEK          0x36
#define API_FILE_TELL          0x37
60
#define API_FILE_STAT          0x38
61
62

#define API_RTC_GET_SECONDS    0x40
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
/* clang-format on */

typedef uint32_t api_int_id_t;

/**
 * Interrupts
 * ==========
 * Next to API calls, Epicardium API also has an interrupt mechanism to serve
 * the other direction.  These interrupts can be enabled/disabled
 * (masked/unmasked) using :c:func:`epic_interrupt_enable` and
 * :c:func:`epic_interrupt_disable`.
 */

/**
 * Enable/unmask an API interrupt.
 *
 * :param int_id: The interrupt to be enabled
 */
API(API_INTERRUPT_ENABLE, int epic_interrupt_enable(api_int_id_t int_id));

/**
 * Disable/mask an API interrupt.
 *
 * :param int_id: The interrupt to be disabled
 */
API(API_INTERRUPT_DISABLE, int epic_interrupt_disable(api_int_id_t int_id));

/**
 * The following interrupts are defined:
 */
93

94
95
96
97
98
99
100
101
102
103
104
/* clang-format off */
/** Reset Handler? **TODO** */
#define EPIC_INT_RESET                  0
/** ``^C`` interrupt. See :c:func:`epic_isr_ctrl_c` for details.  */
#define EPIC_INT_CTRL_C                 1
/* Debug interrupt, please ignore */
#define EPIC_INT_BHI160_TEST            2
API_ISR(EPIC_INT_BHI160_TEST, epic_isr_bhi160_test);

/* Number of defined interrupts. */
#define EPIC_INT_NUM                    3
Rahix's avatar
Rahix committed
105
106
/* clang-format on */

107
108
109
API_ISR(EPIC_INT_RESET, epic_isr_reset);


Rahix's avatar
Rahix committed
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
/**
 * UART/Serial Interface
 * =====================
 */

/**
 * Write a string to all connected serial devices.  This includes:
 *
 * - Real UART, whose pins are mapped onto USB-C pins.  Accessible via the HW-debugger.
 * - A CDC-ACM device available via USB.
 * - Maybe, in the future, bluetooth serial?
 *
 * :param str:  String to write.  Does not necessarily have to be NULL-terminated.
 * :param length:  Amount of bytes to print.
 */
Rahix's avatar
Rahix committed
125
API(API_UART_WRITE, void epic_uart_write_str(const char *str, intptr_t length));
Rahix's avatar
Rahix committed
126

Rahix's avatar
Rahix committed
127
128
/**
 * Blocking read a single character from any connected serial device.
129
130
131
132
133
 * ``epic_uart_read_chr`` only returns once one byte has been read.
 *
 * .. todo::
 *
 *    This API function is currently in violation of the API rules.
Rahix's avatar
Rahix committed
134
135
136
 *
 * :return:  The byte.
 */
Rahix's avatar
Rahix committed
137
138
API(API_UART_READ, char epic_uart_read_chr(void));

139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/**
 * **Interrupt Service Routine**
 *
 * A user-defineable ISR which is triggered when a ``^C`` (``0x04``) is received
 * on any serial input device.  This function is weakly aliased to
 * :c:func:`epic_isr_default` by default.
 *
 * To enable this interrupt, you need to enable :c:data:`EPIC_INT_CTRL_C`:
 *
 * .. code-block:: cpp
 *
 *    epic_interrupt_enable(EPIC_INT_CTRL_C);
 */
API_ISR(EPIC_INT_CTRL_C, epic_isr_ctrl_c);

Rahix's avatar
Rahix committed
154
155
156
157
158
159
160
161
162
163
164
165
166
/**
 * LEDs
 * ====
 */

/**
 * Set one of card10's RGB LEDs to a certain color.
 *
 * :param led:  Which led to set.  0-10 are the leds on the top and 11-14 are the 4 "ambient" leds.
 * :param r:  Red component of the color.
 * :param g:  Green component of the color.
 * :param b:  Blue component of the color.
 */
167
168
API(API_LEDS_SET, void epic_leds_set(int led, uint8_t r, uint8_t g, uint8_t b));

169
170
171
172
173
174
175
176
177
178
/**
 * Sensor Data Streams
 * ===================
 * A few of card10's sensors can do continuous measurements.  To allow
 * performant access to their data, the following function is made for generic
 * access to streams.
 */

/**
 * Read sensor data into a buffer.  ``epic_stream_read()`` will read as many
Rahix's avatar
Rahix committed
179
180
181
182
183
184
185
186
187
188
189
190
 * sensor samples into the provided buffer as possible and return the number of
 * samples written.  If no samples are available, ``epic_stream_read()`` will
 * return ``0`` immediately.
 *
 * ``epic_stream_read()`` expects the provided buffer to have a size which is a
 * multiple of the sample size for the given stream.  For the sample-format and
 * size, please consult the sensors documentation.
 *
 * Before reading the internal sensor sample queue, ``epic_stream_read()`` will
 * call a sensor specific *poll* function to allow the sensor driver to fetch
 * new samples from its hardware.  This should, however, never take a long
 * amount of time.
191
192
193
194
195
196
197
198
199
200
201
 *
 * :param int sd: Sensor Descriptor.  You get sensor descriptors as return
 *    values when activating the respective sensors.
 * :param void* buf: Buffer where sensor data should be read into.
 * :param size_t count: How many bytes to read at max.  Note that fewer bytes
 *    might be read.  In most cases, this should be ``sizeof(buf)``.
 * :return: Number of data packets read (**not** number of bytes) or a negative
 *    error value.  Possible errors:
 *
 *    - ``-ENODEV``: Sensor is not currently available.
 *    - ``-EBADF``: The given sensor descriptor is unknown.
Rahix's avatar
Rahix committed
202
 *    - ``-EINVAL``:  ``count`` is not a multiple of the sensor's sample size.
203
 *    - ``-EBUSY``: The descriptor table lock could not be acquired.
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
 *
 * **Example**:
 *
 * .. code-block:: cpp
 *
 *    #include "epicardium.h"
 *
 *    struct foo_measurement sensor_data[16];
 *    int foo_sd, n;
 *
 *    foo_sd = epic_foo_sensor_enable(9001);
 *
 *    while (1) {
 *            n = epic_stream_read(
 *                    foo_sd,
 *                    &sensor_data,
 *                    sizeof(sensor_data)
 *            );
 *
 *            // Print out the measured sensor samples
 *            for (int i = 0; i < n; i++) {
 *                    printf("Measured: %?\n", sensor_data[i]);
 *            }
 *    }
 */
API(API_STREAM_READ, int epic_stream_read(int sd, void *buf, size_t count));

Rahix's avatar
Rahix committed
231
232
233
234
235
236
237
238
239
240
/**
 * Misc
 * ====
 */

/**
 * Turn vibration motor on or off
 *
 * :param status: 1 to turn on, 0 to turn off.
 */
Gerd's avatar
Gerd committed
241
242
API(API_VIBRA_SET, void epic_vibra_set(int status));

243
244
245
246
247
248
249
/**
 * Turn vibration motor on for a given time
 *
 * :param millis: number of milliseconds to run the vibration motor.
 */
API(API_VIBRA_VIBRATE, void epic_vibra_vibrate(int millis));

Gerd's avatar
Gerd committed
250
251
252
/**
 * Display
 * =======
253
254
255
256
257
258
259
 * The card10 has an LCD screen that can be accessed from user code.
 *
 * There are two main ways to access the display:
 *  - immediate mode, where you ask epicardium to draw shapes and text for you
 *  - framebuffer mode, where you provide epicardium with a memory range where
 *    you already drew graphics whichever way you wanted, and epicardium will
 *    copy them to the display.
Gerd's avatar
Gerd committed
260
261
 */

Rahix's avatar
Rahix committed
262
/** Line-Style */
Rahix's avatar
Rahix committed
263
enum disp_linestyle {
Rahix's avatar
Rahix committed
264
  /** */
Gerd's avatar
Gerd committed
265
  LINESTYLE_FULL = 0,
Rahix's avatar
Rahix committed
266
  /** */
Gerd's avatar
Gerd committed
267
268
269
  LINESTYLE_DOTTED = 1
};

Rahix's avatar
Rahix committed
270
/** Fill-Style */
Rahix's avatar
Rahix committed
271
enum disp_fillstyle {
Rahix's avatar
Rahix committed
272
  /** */
Gerd's avatar
Gerd committed
273
  FILLSTYLE_EMPTY = 0,
Rahix's avatar
Rahix committed
274
  /** */
Gerd's avatar
Gerd committed
275
276
277
  FILLSTYLE_FILLED = 1
};

278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
/** Width of display in pixels */
#define DISP_WIDTH 160

/** Height of display in pixels */
#define DISP_HEIGHT 80

/** Raw framebuffer */
union disp_framebuffer {
  /**
   * The frambuffer stores pixels as RGB565, but byte swapped.
   * That is, for every (x, y) coordinate, there are two uint8_ts
   * storing 16 bits of pixel data.
   *
   * TODO(q3k): document (x, y) in relation to chirality
   *
   * **Example: fill framebuffer with red**:
   *
   * .. code-block:: cpp
   *
   * 	union disp_framebuffer fb;
   * 	uint16_t red = 0b1111100000000000;
   * 	for (int y = 0; y < DISP_HEIGHT; y++) {
   * 		for (int x = 0; x < DISP_WIDTH; x++) {
   * 			fb.fb[y][x][0] = red >> 8;
   * 			fb.fb[y][x][1] = red & 0xFF;
   * 		}
   * 	}
   * 	epic_disp_framebuffer(&fb);
   *
   */
  uint8_t fb[DISP_HEIGHT][DISP_WIDTH][2];
  uint8_t raw[DISP_HEIGHT*DISP_WIDTH*2];
};

Gerd's avatar
Gerd committed
312
313
314
315
/**
 * Locks the display.
 *
 * :return: ``0`` on success or a negative value in case of an error:
Rahix's avatar
Rahix committed
316
317
 *
 *    - ``-EBUSY``: Display was already locked from another task.
Gerd's avatar
Gerd committed
318
319
320
321
322
323
324
 */
API(API_DISP_OPEN, int epic_disp_open());

/**
 * Unlocks the display again.
 *
 * :return: ``0`` on success or a negative value in case of an error:
Rahix's avatar
Rahix committed
325
326
 *
 *    - ``-EBUSY``: Display was already locked from another task.
Gerd's avatar
Gerd committed
327
328
329
330
331
332
 */
API(API_DISP_CLOSE, int epic_disp_close());

/**
 * Causes the changes that have been written to the framebuffer
 * to be shown on the display
333
334
335
 * :return: ``0`` on success or a negative value in case of an error:
 *
 *    - ``-EBUSY``: Display was already locked from another task.
Gerd's avatar
Gerd committed
336
337
338
339
340
341
342
343
344
345
346
347
 */
API(API_DISP_UPDATE, int epic_disp_update());

/**
 * Prints a string into the display framebuffer
 *
 * :param posx: x position to print to. 0 <= x <= 160
 * :param posy: y position to print to. 0 <= y <= 80
 * :param pString: string to print
 * :param fg: foreground color in rgb565
 * :param bg: background color in rgb565
 * :return: ``0`` on success or a negative value in case of an error:
Rahix's avatar
Rahix committed
348
349
 *
 *    - ``-EBUSY``: Display was already locked from another task.
Gerd's avatar
Gerd committed
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 */
API(API_DISP_PRINT,
    int epic_disp_print(
	    uint16_t posx,
	    uint16_t posy,
	    const char *pString,
	    uint16_t fg,
	    uint16_t bg)
    );

/**
 * Fills the whole screen with one color
 *
 * :param color: fill color in rgb565
 * :return: ``0`` on success or a negative value in case of an error:
Rahix's avatar
Rahix committed
365
366
 *
 *    - ``-EBUSY``: Display was already locked from another task.
Gerd's avatar
Gerd committed
367
368
369
 */
API(API_DISP_CLEAR, int epic_disp_clear(uint16_t color));

370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
/**
 * Draws a pixel on the display
 *
 * :param x: x position; 0 <= x <= 160
 * :param y: y position; 0 <= y <= 80
 * :param color: pixel color in rgb565
 * :return: ``0`` on success or a negative value in case of an error:
 *
 *    - ``-EBUSY``: Display was already locked from another task.
 */
API(API_DISP_PIXEL,
    int epic_disp_pixel(
	    uint16_t x,
	    uint16_t y,
	    uint16_t color)
    );

Gerd's avatar
Gerd committed
387
388
389
390
391
392
393
394
395
396
397
/**
 * Draws a line on the display
 *
 * :param xstart: x starting position; 0 <= x <= 160
 * :param ystart: y starting position; 0 <= y <= 80
 * :param xend: x ending position; 0 <= x <= 160
 * :param yend: y ending position; 0 <= y <= 80
 * :param color: line color in rgb565
 * :param linestyle: 0 for solid, 1 for dottet (almost no visual difference)
 * :param pixelsize: thickness of the line; 1 <= pixelsize <= 8
 * :return: ``0`` on success or a negative value in case of an error:
Rahix's avatar
Rahix committed
398
399
 *
 *    - ``-EBUSY``: Display was already locked from another task.
Gerd's avatar
Gerd committed
400
401
402
403
404
405
406
407
 */
API(API_DISP_LINE,
    int epic_disp_line(
	    uint16_t xstart,
	    uint16_t ystart,
	    uint16_t xend,
	    uint16_t yend,
	    uint16_t color,
Rahix's avatar
Rahix committed
408
	    enum disp_linestyle linestyle,
Gerd's avatar
Gerd committed
409
410
411
412
413
414
415
416
417
418
419
420
421
422
	    uint16_t pixelsize)
    );

/**
 * Draws a rectangle on the display
 *
 * :param xstart: x coordinate of top left corner; 0 <= x <= 160
 * :param ystart: y coordinate of top left corner; 0 <= y <= 80
 * :param xend: x coordinate of bottom right corner; 0 <= x <= 160
 * :param yend: y coordinate of bottom right corner; 0 <= y <= 80
 * :param color: line color in rgb565
 * :param fillstyle: 0 for empty, 1 for filled
 * :param pixelsize: thickness of the rectangle outline; 1 <= pixelsize <= 8
 * :return: ``0`` on success or a negative value in case of an error:
Rahix's avatar
Rahix committed
423
424
 *
 *    - ``-EBUSY``: Display was already locked from another task.
Gerd's avatar
Gerd committed
425
426
427
428
429
430
431
432
 */
API(API_DISP_RECT,
    int epic_disp_rect(
	    uint16_t xstart,
	    uint16_t ystart,
	    uint16_t xend,
	    uint16_t yend,
	    uint16_t color,
Rahix's avatar
Rahix committed
433
	    enum disp_fillstyle fillstyle,
Gerd's avatar
Gerd committed
434
435
436
437
438
439
440
441
442
443
444
445
446
	    uint16_t pixelsize)
    );

/**
 * Draws a circle on the display
 *
 * :param x: x coordinate of the center; 0 <= x <= 160
 * :param y: y coordinate of the center; 0 <= y <= 80
 * :param rad: radius of the circle
 * :param color: fill and outline color of the circle (rgb565)
 * :param fillstyle: 0 for empty, 1 for filled
 * :param pixelsize: thickness of the circle outline; 1 <= pixelsize <= 8
 * :return: ``0`` on success or a negative value in case of an error:
Rahix's avatar
Rahix committed
447
448
 *
 *    - ``-EBUSY``: Display was already locked from another task.
Gerd's avatar
Gerd committed
449
450
451
452
453
454
455
 */
API(API_DISP_CIRC,
    int epic_disp_circ(
	    uint16_t x,
	    uint16_t y,
	    uint16_t rad,
	    uint16_t color,
Rahix's avatar
Rahix committed
456
	    enum disp_fillstyle fillstyle,
Gerd's avatar
Gerd committed
457
458
	    uint16_t pixelsize)
    );
459

460
461
462
463
464
465
466
467
468
469
470
471
/**
 * Immediately send the contents of a framebuffer to the display. This overrides
 * anything drawn by immediate mode graphics and displayed using ``epic_disp_update``.
 *
 * :param fb: framebuffer to display
 * :return: ``0`` on success or negative value in case of an error:
 *
 *    - ``-EBUSY``: Display was already locked from another task.
 */
API(API_DISP_FRAMEBUFFER, int epic_disp_framebuffer(union disp_framebuffer *fb));


472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
/**
 * Start continuous readout of the light sensor. Will read light level
 * at preconfigured interval and make it available via `epic_light_sensor_get()`.
 *
 * If the continuous readout was already running, this function will silently pass.
 *
 *
 * :return: `0` if the start was successful or a negative error value
 *      if an error occured. Possible errors:
 *
 *      - ``-EBUSY``: The timer could not be scheduled.
 */
API(API_LIGHT_SENSOR_RUN, int epic_light_sensor_run());

/**
 * Get the last light level measured by the continuous readout.
 *
 * :param uint16_t* value: where the last light level should be written.
 * :return: `0` if the readout was successful or a negative error
 *      value. Possible errors:
 *
 *      - ``-ENODATA``: Continuous readout not currently running.
 */
API(API_LIGHT_SENSOR_GET, int epic_light_sensor_get(uint16_t* value));


/**
 * Stop continuous readout of the light sensor.
 *
 * If the continuous readout wasn't running, this function will silently pass.
 *
 * :return: `0` if the stop was sucessful or a negative error value
 *      if an error occured. Possible errors:
 *
 *      - ``-EBUSY``: The timer stop could not be scheduled.
 */
API(API_LIGHT_SENSOR_STOP, int epic_light_sensor_stop());

510
511
512
/**
 * File
 * ====
513
514
 * Except for :c:func:`epic_file_open`, which models C stdio's ``fopen``
 * function, ``close``, ``read`` and ``write`` model `close(2)`_, `read(2)`_ and
Rahix's avatar
Rahix committed
515
516
517
518
519
520
521
522
523
524
525
526
 * `write(2)`_.  All file-related functions return >= ``0`` on success and
 * ``-Exyz`` on failure, with error codes from errno.h (``EIO``, ``EINVAL``
 * etc.)
 *
 * .. _close(2): http://man7.org/linux/man-pages/man2/close.2.html
 * .. _read(2): http://man7.org/linux/man-pages/man2/read.2.html
 * .. _write(2): http://man7.org/linux/man-pages/man2/write.2.html
 */

/** */
API(
	API_FILE_OPEN,
Rahix's avatar
Rahix committed
527
	int epic_file_open(const char* filename, const char* modeString)
Rahix's avatar
Rahix committed
528
529
530
);

/** */
Rahix's avatar
Rahix committed
531
API(API_FILE_CLOSE, int epic_file_close(int fd));
Rahix's avatar
Rahix committed
532
533

/** */
Rahix's avatar
Rahix committed
534
API(API_FILE_READ, int epic_file_read(int fd, void* buf, size_t nbytes));
Rahix's avatar
Rahix committed
535
536
537
538

/** */
API(
	API_FILE_WRITE,
Rahix's avatar
Rahix committed
539
	int epic_file_write(int fd, const void* buf, size_t nbytes)
Rahix's avatar
Rahix committed
540
541
542
);

/** */
Rahix's avatar
Rahix committed
543
API(API_FILE_FLUSH, int epic_file_flush(int fd));
544

545
546
547
548
549
550
/** */
API(API_FILE_SEEK, int epic_file_seek(int fd, long offset, int whence));

/** */
API(API_FILE_TELL, int epic_file_tell(int fd));

Rahix's avatar
Rahix committed
551
/** */
552
enum epic_stat_type {
Rahix's avatar
Rahix committed
553
554
555
556
	/** */
	EPICSTAT_FILE,
	/** */
	EPICSTAT_DIR,
557
558
};

Rahix's avatar
Rahix committed
559
/** */
560
typedef struct epic_stat_t {
Rahix's avatar
Rahix committed
561
562
	/** */
	enum epic_stat_type type;
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
} epic_stat_t;

/**
 * stat path
 *
 * This does not follow posix convention, but rather takes
 * a path as parameter. This aligns more with libff's API and
 * also this has been implemented for python import support, which
 * passes the filename as well.
 *
 * :param const char* filename: path to stat
 * :param epic_stat_t* stat: pointer to result
 *
 * :return: `0` on success, negative on error
 */
Rahix's avatar
Rahix committed
578
API(API_FILE_STAT, int epic_file_stat(const char* path, epic_stat_t* stat));
579

580
581
582
583
584
585
586
587
588
589
590
591
/**
 * RTC
 * ===
 */

/**
 * Read the current RTC value.
 *
 * :return: Unix time in seconds
 */
API(API_RTC_GET_SECONDS, uint32_t epic_rtc_get_seconds(void));

Rahix's avatar
Rahix committed
592
#endif /* _EPICARDIUM_H */