clean up pbdrv naming

11 files changed, 66 insertions, 61 deletions

diff --git a/lib/pbdrv/drv/arduino/mod.cpp b/lib/pbdrv/drv/arduino/mod.cpp
index 8a38a5b..fab9dd5 100644
--- a/lib/pbdrv/drv/arduino/mod.cpp
+++ b/lib/pbdrv/drv/arduino/mod.cpp
@@ -18,17 +18,17 @@ static void recv_event(int bytes) {
 	while (Wire.available())
 		data[size++] = Wire.read();
 
-	pbdrv_i2c_recv(data, size);
+	pb_i2c_recv(data, size);
 }
 
-void pbdrv_setup() {
-	Wire.begin((int) PBDRV_MOD_ADDR);
+void pb_setup() {
+	Wire.begin((int) PB_MOD_ADDR);
 	Wire.setWireTimeout(PB_TIMEOUT_US, true);
 	Wire.setClock(PB_CLOCK_SPEED_HZ);
 	Wire.onReceive(recv_event);
 }
 
-__weak void pbdrv_i2c_send(i2c_addr_t addr, const uint8_t * buf, size_t sz) {
+__weak void pb_i2c_send(i2c_addr_t addr, const uint8_t * buf, size_t sz) {
 	Wire.beginTransmission((int) addr);
 	Wire.write(buf, sz);
 	Wire.endTransmission(true);
diff --git a/lib/pbdrv/drv/arduino/mod.h b/lib/pbdrv/drv/arduino/mod.h
index 079941a..c4cb9ce 100644
--- a/lib/pbdrv/drv/arduino/mod.h
+++ b/lib/pbdrv/drv/arduino/mod.h
@@ -9,7 +9,7 @@ extern "C" {
  *
  * This function should be called from the Arduino \c setup() function.
  */
-void pbdrv_setup();
+void pb_setup();
 
 #ifdef __cplusplus
 }
diff --git a/lib/pbdrv/mod/main.h b/lib/pbdrv/mod/main.h
index 535ce06..ec48acd 100644
--- a/lib/pbdrv/mod/main.h
+++ b/lib/pbdrv/mod/main.h
@@ -1,6 +1,6 @@
 #pragma once
 
-#include "../types.h"
+#include "../pb-types.h"
 
 typedef struct {
 	const i2c_addr_t mod_addr;
diff --git a/lib/pbdrv/pb-buf.c b/lib/pbdrv/pb-buf.c
index 673040f..5dfaa66 100644
--- a/lib/pbdrv/pb-buf.c
+++ b/lib/pbdrv/pb-buf.c
@@ -2,7 +2,7 @@
 
 #include <stdlib.h>
 
-void pbdrv_buf_free(pbdrv_buf_t * buf) {
+void pb_buf_free(pb_buf_t * buf) {
 	if (buf->data == NULL) return;
 	free(buf->data);
 	buf->data = NULL;
diff --git a/lib/pbdrv/pb-buf.h b/lib/pbdrv/pb-buf.h
index 149b384..671f344 100644
--- a/lib/pbdrv/pb-buf.h
+++ b/lib/pbdrv/pb-buf.h
@@ -10,9 +10,9 @@ extern "C" {
 typedef struct {
 	char * data; //! pointer to data
 	size_t size; //! size of data
-} pbdrv_buf_t;
+} pb_buf_t;
 
-void pbdrv_buf_free(pbdrv_buf_t * buf);
+void pb_buf_free(pb_buf_t * buf);
 
 #ifdef __cplusplus
 }
diff --git a/lib/pbdrv/pb-mod.c b/lib/pbdrv/pb-mod.c
index 740f2a5..f5c9a34 100644
--- a/lib/pbdrv/pb-mod.c
+++ b/lib/pbdrv/pb-mod.c
@@ -2,7 +2,7 @@
 #include "pb.h"
 
 //! fallback module name
-__weak const char * PBDRV_MOD_NAME = "???";
+__weak const char * PB_MOD_NAME = "???";
 
 //! [private] placeholder global state variable
 static pb_global_state_t _global_state = PB_GS_NOINIT;
@@ -10,17 +10,17 @@ static pb_global_state_t _global_state = PB_GS_NOINIT;
 //! [private] main controller global state
 static pb_global_state_t _main_state = PB_GS_NOINIT;
 
-// __weak enum pb_state pbdrv_hook_mod_state_read() {
+// __weak enum pb_state pb_hook_mod_state_read() {
 // 	return _global_state;
 // }
 
-// __weak void pbdrv_hook_mod_state_write(enum pb_state state) {
+// __weak void pb_hook_mod_state_write(enum pb_state state) {
 // 	_global_state = state;
 // }
 
-__weak void pbdrv_i2c_recv(const uint8_t * buf, size_t sz) {
+__weak void pb_i2c_recv(const uint8_t * buf, size_t sz) {
 	return;
 }
  
-__weak void pbdrv_hook_main_state_update(pb_global_state_t state) { }
+__weak void pb_hook_main_state_update(pb_global_state_t state) { }
 
diff --git a/lib/pbdrv/pb-mod.h b/lib/pbdrv/pb-mod.h
index fa290bf..549bdcb 100644
--- a/lib/pbdrv/pb-mod.h
+++ b/lib/pbdrv/pb-mod.h
@@ -3,7 +3,7 @@
 /**
  * \file puzzle bus driver implementation
  *
- * Most \c pbdrv_* functions have a weak implementation, which may be
+ * Most \c pb_* functions have a weak implementation, which may be
  * overwritten by a custom implementation. This allows you to use the default
  * implementation where possible, and only implement extensions required for
  * your puzzle module. Please see spec.adoc for more information about how to
@@ -21,12 +21,12 @@ extern "C" {
 #endif
 
 //! puzzle module name (optional, default = "???")
-extern const char * PBDRV_MOD_NAME;
+extern const char * PB_MOD_NAME;
 //! puzzle module bus address (required)
-extern const i2c_addr_t PBDRV_MOD_ADDR;
+extern const i2c_addr_t PB_MOD_ADDR;
 
-void pbdrv_i2c_recv(const uint8_t * buf, size_t sz);
-void pbdrv_i2c_send(i2c_addr_t i2c_addr, const uint8_t * buf, size_t sz);
+void pb_i2c_recv(const uint8_t * buf, size_t sz);
+void pb_i2c_send(i2c_addr_t i2c_addr, const uint8_t * buf, size_t sz);
 
 #ifdef __cplusplus
 }
diff --git a/lib/pbdrv/pb-msg.c b/lib/pbdrv/pb-msg.c
index ead9f09..8ffd7cc 100644
--- a/lib/pbdrv/pb-msg.c
+++ b/lib/pbdrv/pb-msg.c
@@ -3,30 +3,35 @@
 #include "pb-msg.h"
 #include "pb-serial.h"
 
-pbdrv_buf_t pbdrv_msg_write(const pb_msg_t * msg) {
-	pbdrv_buf_t buf = { 0 };
+pb_buf_t pb_msg_write(const pb_msg_t * msg) {
+	pb_buf_t buf = { 0 };
 	mpack_writer_t writer;
 
 	mpack_writer_init_growable(&writer, &buf.data, &buf.size);
 
-	pbdrv_serialize(&writer, msg);
+	pb_ser_w(&writer, msg);
 
 	mpack_writer_destroy(&writer);
 	return buf;
 }
 
-pb_msg_t * pbdrv_msg_read(const pbdrv_buf_t * buf) {
+pb_msg_t * pb_msg_read(const pb_buf_t * buf) {
 	mpack_reader_t reader;
 	mpack_reader_init_data(&reader, buf->data, buf->size);
 
 	pb_msg_t * msg = malloc(sizeof(pb_msg_t));
 
-	pbdrv_deserialize(&reader, msg);
+	pb_ser_r(&reader, msg);
 
+	mpack_reader_destroy(&reader);
 	return msg;
 }
 
-void pbdrv_msg_free(pb_msg_t * msg) {
-	pbdrv_free(msg);
+void pb_msg_free(pb_msg_t * msg) {
+	// free message fields recursively
+	pb_ser_free(msg);
+
+	// free message container that was created in \p pb_msg_read
+	free(msg);
 }
 
diff --git a/lib/pbdrv/pb-msg.h b/lib/pbdrv/pb-msg.h
index 9823d57..f27d4c4 100644
--- a/lib/pbdrv/pb-msg.h
+++ b/lib/pbdrv/pb-msg.h
@@ -7,9 +7,9 @@
 extern "C" {
 #endif
 
-pbdrv_buf_t pbdrv_msg_write(const pb_msg_t * msg);
-pb_msg_t * pbdrv_msg_read(const pbdrv_buf_t * buf);
-void pbdrv_msg_free(pb_msg_t * msg);
+pb_buf_t pb_msg_write(const pb_msg_t * msg);
+pb_msg_t * pb_msg_read(const pb_buf_t * buf);
+void pb_msg_free(pb_msg_t * msg);
 
 #ifdef __cplusplus
 }
diff --git a/lib/pbdrv/pb-serial.c b/lib/pbdrv/pb-serial.c
index 95bb8fb..9b20bf9 100644
--- a/lib/pbdrv/pb-serial.c
+++ b/lib/pbdrv/pb-serial.c
@@ -3,68 +3,68 @@
 #include "pb-serial.h"
 #include "pb-types.h"
 
-void pbdrv_serialize(mpack_writer_t * writer, const pb_msg_t * msg) {
-	pbdrv_sr_msg_header(writer, msg);
+void pb_ser_w(mpack_writer_t * writer, const pb_msg_t * msg) {
+	pb_ser_w_msg_header(writer, msg);
 	if (msg->msg == NULL) return;
 	switch (msg->type) {
-		case PB_CMD_REQ_READ: return pbdrv_sr_cmd_req_read(writer, msg);
-		case PB_CMD_RES_READ: return pbdrv_sr_cmd_res_read(writer, msg);
+		case PB_CMD_REQ_READ: return pb_ser_w_cmd_req_read(writer, msg);
+		case PB_CMD_RES_READ: return pb_ser_w_cmd_res_read(writer, msg);
 		default: break;
 	}
 }
-void pbdrv_deserialize(mpack_reader_t * reader, pb_msg_t * msg) {
-	pbdrv_dsr_msg_header(reader, msg);
+void pb_ser_r(mpack_reader_t * reader, pb_msg_t * msg) {
+	pb_ser_r_msg_header(reader, msg);
 	switch (msg->type) {
-		case PB_CMD_REQ_READ: return pbdrv_dsr_cmd_req_read(reader, msg);
-		case PB_CMD_RES_READ: return pbdrv_dsr_cmd_res_read(reader, msg);
+		case PB_CMD_REQ_READ: return pb_ser_r_cmd_req_read(reader, msg);
+		case PB_CMD_RES_READ: return pb_ser_r_cmd_res_read(reader, msg);
 		default: break;
 	}
 }
-void pbdrv_free(pb_msg_t * msg) {
+void pb_ser_free(pb_msg_t * msg) {
 	if (msg == NULL) return;
 
 	switch (msg->type) {
-		case PB_CMD_REQ_READ: return pbdrv_free_cmd_req_read(msg);
-		case PB_CMD_RES_READ: return pbdrv_free_cmd_res_read(msg);
+		case PB_CMD_REQ_READ: return pb_ser_free_cmd_req_read(msg);
+		case PB_CMD_RES_READ: return pb_ser_free_cmd_res_read(msg);
 		default: break;
 	}
-	pbdrv_free_msg_header(msg);
+	pb_ser_free_msg_header(msg);
 }
 
-void pbdrv_sr_msg_header(mpack_writer_t * writer, const pb_msg_t * msg) {
+void pb_ser_w_msg_header(mpack_writer_t * writer, const pb_msg_t * msg) {
 	mpack_write_u8(writer, msg->type);
-	// TODO: if pbdrv is compiled under the pbdrv-mod target, place
-	// PBDRV_MOD_ADDR in this field
+	// TODO: if pb is compiled under the pb-mod target, place
+	// PB_MOD_ADDR in this field
 	mpack_write_u16(writer, msg->sender);
 }
-void pbdrv_dsr_msg_header(mpack_reader_t * reader, pb_msg_t * msg) {
+void pb_ser_r_msg_header(mpack_reader_t * reader, pb_msg_t * msg) {
 	msg->type = mpack_expect_u8(reader);
 	msg->sender = mpack_expect_u16(reader);
 }
-void pbdrv_free_msg_header(pb_msg_t * msg) { }
+void pb_ser_free_msg_header(pb_msg_t * msg) { }
 
-void pbdrv_sr_cmd_req_read(mpack_writer_t * writer, const pb_msg_t * _msg) {
+void pb_ser_w_cmd_req_read(mpack_writer_t * writer, const pb_msg_t * _msg) {
 	pb_cmd_req_read_t * msg = _msg->msg;
 	mpack_write_u8(writer, msg->propid);
 }
-void pbdrv_dsr_cmd_req_read(mpack_reader_t * reader, pb_msg_t * _msg) {
+void pb_ser_r_cmd_req_read(mpack_reader_t * reader, pb_msg_t * _msg) {
 	pb_cmd_req_read_t * msg = _msg->msg = malloc(sizeof(pb_cmd_req_read_t));
 	msg->propid = mpack_expect_u8(reader);
 }
-void pbdrv_free_cmd_req_read(pb_msg_t * _msg) {
+void pb_ser_free_cmd_req_read(pb_msg_t * _msg) {
 	if (_msg->msg != NULL) {
 		free(_msg->msg);
 		_msg->msg = NULL;
 	}
 }
 
-void pbdrv_sr_cmd_res_read(mpack_writer_t * writer, const pb_msg_t * _msg) {
+void pb_ser_w_cmd_res_read(mpack_writer_t * writer, const pb_msg_t * _msg) {
 	pb_cmd_res_read_t * msg = _msg->msg;
 
 	mpack_write_u8(writer, msg->propid);
 	mpack_write_bin(writer, (char *) msg->value, msg->_value_size);
 }
-void pbdrv_dsr_cmd_res_read(mpack_reader_t * reader, pb_msg_t * _msg) {
+void pb_ser_r_cmd_res_read(mpack_reader_t * reader, pb_msg_t * _msg) {
 	pb_cmd_res_read_t * msg = _msg->msg = malloc(sizeof(pb_cmd_res_read_t));
 
 	msg->propid = mpack_expect_u8(reader);
@@ -72,7 +72,7 @@ void pbdrv_dsr_cmd_res_read(mpack_reader_t * reader, pb_msg_t * _msg) {
 	msg->value = (uint8_t *) mpack_read_bytes_alloc(reader, msg->_value_size);
 	mpack_done_bin(reader);
 }
-void pbdrv_free_cmd_res_read(pb_msg_t * _msg) {
+void pb_ser_free_cmd_res_read(pb_msg_t * _msg) {
 	if (_msg->msg != NULL) {
 		pb_cmd_res_read_t * msg = _msg->msg;
 		if (msg->value != NULL) {
diff --git a/lib/pbdrv/pb-serial.h b/lib/pbdrv/pb-serial.h
index ac89838..22031dc 100644
--- a/lib/pbdrv/pb-serial.h
+++ b/lib/pbdrv/pb-serial.h
@@ -9,18 +9,18 @@ extern "C" {
 #endif
 
 #define __pb_cmd(name) \
-	pbdrv_serialize_t pbdrv_sr_##name; \
-	pbdrv_deserialize_t pbdrv_dsr_##name; \
-	pbdrv_free_t pbdrv_free_##name;
+	pb_ser_r_t pb_ser_r_##name; \
+	pb_ser_w_t pb_ser_w_##name; \
+	pb_ser_free_t pb_ser_free_##name;
 
-typedef void pbdrv_serialize_t(mpack_writer_t * writer, const pb_msg_t * msg);
-pbdrv_serialize_t pbdrv_serialize;
+typedef void pb_ser_w_t(mpack_writer_t * writer, const pb_msg_t * msg);
+pb_ser_w_t pb_ser_w;
 
-typedef void pbdrv_deserialize_t(mpack_reader_t * reader, pb_msg_t * msg);
-pbdrv_deserialize_t pbdrv_deserialize;
+typedef void pb_ser_r_t(mpack_reader_t * reader, pb_msg_t * msg);
+pb_ser_r_t pb_ser_r;
 
-typedef void pbdrv_free_t(pb_msg_t * msg);
-pbdrv_free_t pbdrv_free;
+typedef void pb_ser_free_t(pb_msg_t * msg);
+pb_ser_free_t pb_ser_free;
 
 __pb_cmd(msg_header)
 __pb_cmd(cmd_req_read)