aboutsummaryrefslogtreecommitdiff
path: root/proto
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-05-28 11:28:22 +0200
committerLoek Le Blansch <loek@pipeframe.xyz>2024-05-28 11:28:22 +0200
commit25a4f905a3f93645aee79157f30867b287871163 (patch)
tree3f33d41965595cafe5cc0ae783840ffdd3ca27ba /proto
parentf4868604384908a7477cbb4b544c6ee7aac2a883 (diff)
separate the i2c over tcp from puzzle bus libraries
Diffstat (limited to 'proto')
-rw-r--r--proto/include.cmake16
l---------proto/lib1
-rw-r--r--proto/puzbusv1.c55
-rw-r--r--proto/puzbusv1.h89
4 files changed, 0 insertions, 161 deletions
diff --git a/proto/include.cmake b/proto/include.cmake
deleted file mode 100644
index ac1305e..0000000
--- a/proto/include.cmake
+++ /dev/null
@@ -1,16 +0,0 @@
-include_directories(${CMAKE_CURRENT_LIST_DIR})
-add_library(puzbus STATIC
- ${CMAKE_CURRENT_LIST_DIR}/puzbusv1.c
- )
-
-# mpack
-include_directories(${CMAKE_CURRENT_LIST_DIR}/lib/mpack/src/mpack)
-add_library(mpack STATIC
- ${CMAKE_CURRENT_LIST_DIR}/lib/mpack/src/mpack/mpack-common.c
- ${CMAKE_CURRENT_LIST_DIR}/lib/mpack/src/mpack/mpack-expect.c
- ${CMAKE_CURRENT_LIST_DIR}/lib/mpack/src/mpack/mpack-node.c
- ${CMAKE_CURRENT_LIST_DIR}/lib/mpack/src/mpack/mpack-platform.c
- ${CMAKE_CURRENT_LIST_DIR}/lib/mpack/src/mpack/mpack-reader.c
- ${CMAKE_CURRENT_LIST_DIR}/lib/mpack/src/mpack/mpack-writer.c
- )
-
diff --git a/proto/lib b/proto/lib
deleted file mode 120000
index dc598c5..0000000
--- a/proto/lib
+++ /dev/null
@@ -1 +0,0 @@
-../lib \ No newline at end of file
diff --git a/proto/puzbusv1.c b/proto/puzbusv1.c
deleted file mode 100644
index 73deda5..0000000
--- a/proto/puzbusv1.c
+++ /dev/null
@@ -1,55 +0,0 @@
-#include <mpack.h>
-#include <stdio.h>
-
-// MIN() macro
-#include <sys/param.h>
-// TODO: check if this works on pico as well
-
-#include "puzbusv1.h"
-
-int pb_read(struct pb_msg * target, const char * buf, size_t buf_sz) {
- // a new reader is used per buffer block passed to this function
- mpack_reader_t reader;
- mpack_reader_init_data(&reader, buf, buf_sz);
-
- // at start of message
- if (target->_rdata == 0) {
- // NOTE: The entire start of a message needs to be readable from the buffer
- // at this point. When target->addr can be read and target->length is past
- // the end of the current buffer block, this function will crash and burn.
- // This is a highly unlikely scenario, as pb_read is called for each chunk
- // of a TCP frame, and frames (should) include only one puzzle bus message.
- // The check here is kind of optional.
- if (buf_sz < 4) return -1;
-
- target->addr = mpack_expect_u16(&reader);
- target->length = target->_rdata = mpack_expect_bin(&reader);
- target->data = (char *) malloc(target->length);
- }
-
- // continue reading chunks of target->data until the amount of bytes
- // specified in target->length
- size_t to_read = MIN(mpack_reader_remaining(&reader, NULL), target->_rdata);
- char * data = target->data + target->length - target->_rdata;
- mpack_read_bytes(&reader, data, to_read);
- target->_rdata -= to_read;
-
- // if rdata = 0, the message was completely read
- return target->_rdata;
-}
-
-void pb_read_reset(struct pb_msg * target) {
- target->_rdata = 0;
-}
-
-bool pb_write(const struct pb_msg * target, char ** buf, size_t * buf_sz) {
- mpack_writer_t writer;
- mpack_writer_init_growable(&writer, buf, buf_sz);
-
- mpack_write_u16(&writer, target->addr);
- mpack_write_bin(&writer, target->data, target->length);
-
- // finish writing
- return mpack_writer_destroy(&writer) == mpack_ok;
-}
-
diff --git a/proto/puzbusv1.h b/proto/puzbusv1.h
deleted file mode 100644
index 9f4f8e5..0000000
--- a/proto/puzbusv1.h
+++ /dev/null
@@ -1,89 +0,0 @@
-#pragma once
-
-#include <stddef.h>
-#include <stdint.h>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/** \brief Puzzle bus message (v1) */
-struct pb_msg {
- uint16_t addr; //!< I^2^C address
- char * data; //!< message content
- size_t length; //!< message size
- size_t _rdata; //!< \private remaining bytes to read until message is complete
-};
-
-/**
- * \brief Read chunk of input stream, and store resulting message in \p target
- *
- * This function is called for each chunk of data from an input stream, and
- * will parse the next puzzle bus message into \p target. The input stream is
- * assumed to only contain messages encoded by \p pb_write()
- *
- * \param target pointer to struct that will contain the finished message data
- * \param buf pointer to input stream data chunk
- * \param buf_sz size of \p buf
- *
- * \returns Integer representing amount of bytes required to finish message, or
- * -1 if the message header could not be read. If this function returns 0, the
- * message in \p target is complete.
- *
- * \note target->data will automatically be allocated by this function, even if
- * the message is not fully parsed. This variable must be `free()`d by the
- * caller after each complete message to prevent memory leaks.
- */
-int pb_read(struct pb_msg * target, const char * buf, size_t buf_sz);
-
-/**
- * \brief reset the remaining message data counter
- *
- * Calling this function has the effect of forcing \c pb_read() to parse the
- * next buffer chunk as the start of a new message. This function may be called
- * before reading a TCP frame's data to mitigate any synchronization issues
- * arising from earlier corrupt or otherwise malformed messages.
- */
-void pb_read_reset(struct pb_msg * target);
-
-/**
- * \brief Allocate and write a msgpack-formatted message to \p buf
- *
- * This function allocates a buffer large enough to fit the message specified
- * in \p target, and encodes the data in \p target in a format that can be
- * decoded later using \p pb_read()
- *
- * \param target pointer to struct that contains the message data
- * \param buf pointer to \c char* that will contain the formatted message
- * \param buf_sz pointer to \c size_t that will represent the final size of \p buf
- *
- * \returns boolean true if a the message could be encoded successfully, false
- * if there was some kind of error
- *
- * \note the pointer stored in \p buf must be `free()`d by the caller afterwards
- */
-bool pb_write(const struct pb_msg * target, char ** buf, size_t * buf_sz);
-
-/**
- * \brief I^2^C puzzle bus command types
- *
- * The first byte of a puzzle bus message's data indicates the command type.
- */
-enum pb_cmd {
- PB_CMD_READ, //!< read a puzzle module property
- PB_CMD_WRITE, //!< write to a puzzle module property
- // PB_CMD_UPDATE, //!< request an update
-};
-
-/** \brief Puzzle bus global states */
-enum pb_global_state {
- PB_GS_NOINIT, //!< uninitialized (only used by puzzle modules)
- PB_GS_IDLE, //!< puzzle not started yet
- PB_GS_PLAYING, //!< puzzle actively being solved
- PB_GS_SOLVED, //!< puzzle completed
-};
-
-#ifdef __cplusplus
-}
-#endif
-