aboutsummaryrefslogtreecommitdiff
path: root/lib/pbdrv/drv/arduino/mod.cpp
blob: 581b80abaa213856c30d7ac7b4b53f7543a94224 (plain)
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
#include <Arduino.h>
#include <Wire.h>
#include <avr/delay.h>

#include <FreeRTOS.h>
#include <timers.h>
#include <task.h>

#include "../../pb.h"
#include "../../pb-mod.h"
#include "../../pb-types.h"
#include "../../pb-buf.h"
#include "../../pb-mem.h"

static void async_pb_i2c_recv(void * _msg, uint32_t _) {
	pb_buf_t * msg = (pb_buf_t *) _msg;
	pb_i2c_recv((uint8_t *) msg->data, msg->size);
	pb_buf_free(msg);
	pb_free(msg);
}

static void recv_event(int bytes) {
	pb_buf_t * msg = (pb_buf_t *) pb_malloc(sizeof(pb_buf_t));
	msg->data = (char *) pb_malloc(bytes);
	msg->size = 0;
	while (Wire.available())
		msg->data[msg->size++] = Wire.read();

	// defer pb_i2c_recv call
	xTimerPendFunctionCallFromISR(async_pb_i2c_recv, msg, 0, NULL);
}

static void pb_setup() {
	Wire.begin((int) PB_MOD_ADDR);
	Wire.setWireTimeout(PB_TIMEOUT_US, true);
	Wire.setClock(PB_CLOCK_SPEED_HZ);
	// TODO: check if onReceive replaces or appends a handler function
	Wire.onReceive(recv_event);
}

/**
 * \ingroup pb_drv_arduino
 * \warning This function includes a hard-coded 10ms delay before sending. This
 * is to work around a weird issue where the Arduino pulls both SDA and SCL low
 * while attempting to initiate an I2C transmission. We were able to verify
 * that the Arduino correctly handles bus arbitration under a test scenario
 * with 2 Uno's, but ran into issues while integrating the Arduino's with the
 * RP2040.
 */
__weak void pb_i2c_send(i2c_addr_t addr, const uint8_t * buf, size_t sz) {
	if (pb_hook_i2c_send(addr, buf, sz)) return;

	vTaskDelay(10 / portTICK_PERIOD_MS); // prevent bus collisions
	Wire.beginTransmission((int) addr);
	Wire.write(buf, sz);
	Wire.endTransmission(true);
	Wire.setWireTimeout(PB_TIMEOUT_US, true);
}

//! Arduino setup function
extern void setup(void);
//! Arduino loop function
extern void loop(void);
//! Arduino internal initialization
void init(void);

//! FreeRTOS loop task
void loop_task() {
	for(;;) {
		loop();
		if (serialEventRun) serialEventRun();
	}
}

/**
 * \ingroup pb_drv_arduino
 * \brief Application entrypoint
 *
 * This function overrides the default (weak) implementation of the \c main()
 * function in the Arduino framework. No additional setup is required to use
 * this driver.
 *
 * \note I should really be able to use Arduino's initVariant function for
 * this, but I can't seem to get it to link properly using the CMake setup in
 * this repository. Overriding the main() function seems to work, and the
 * USBCON thing in the default Arduino main() function isn't needed because
 * puzzle modules are likely not using USB.
 */
int main(void) {
	init(); // call arduino internal setup
	setup(); // call regular arduino setup
	pb_setup(); // call pbdrv-mod setup
	xTaskCreate((TaskFunction_t) loop_task, "loop", configMINIMAL_STACK_SIZE, NULL, tskIDLE_PRIORITY + 1, NULL);
	vTaskStartScheduler(); // start freertos scheduler
	return 0;
}