license: update source file and licensing files

[libsi24] / libsi24.h

diff --git a/libsi24.h b/libsi24.h
index 5e2f53c..6d25244 100644 (file)
--- a/libsi24.h
+++ b/libsi24.h
@@ -1,11 +1,20 @@
-/**
- * File              : libsi24.h
- * Author            : Robin Krens <robin@robinkrens.nl>
- * Date              : 18.01.2023
- * Last Modified Date: 18.01.2023
- * Last Modified By  : Robin Krens <robin@robinkrens.nl>
+/* Copyright (C) 
+ * 2023 - Robin Krens
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * 
  */
-
 #include <stddef.h>
 
 #if defined(__cplusplus)
@@ -22,38 +31,88 @@ enum si24_status_t {
 
 typedef enum si24_status_t si24_status_t;
 
-enum si24_type_t {
-    RECV = 0,
-    SEND
+enum si24_mode_t {
+    RECV_MODE = 0,
+    SEND_MODE
 };
 
-typedef enum si24_type_t si24_type_t;
+typedef enum si24_mode_t si24_mode_t;
 
 enum si24_crc_t {
-    ONE_BYTE = 1,
-    TWO_BYTE = 2
+    ONE_BYTE = 0,
+    TWO_BYTE = 1
 };
 
 typedef enum si24_crc_t si24_crc_t;
 
-enum si24_event_t {
-    TEST = 0
+enum si24_speed_t {
+       MBPS1 = 0,
+       MBPS2 = 1,
+       KBPS250 = 2
+};
+
+typedef enum si24_speed_t si24_speed_t;
+
+enum si24_txpower_t {
+       MINUS12DB = 0,
+       MINUS6DB,
+       MINUS4DB,
+       ZERODB,
+       PLUS1DB,
+       PLUS3DB,
+       PLUS4DB,
+       PLUS7DB
+};
+
+typedef enum si24_txpower_t si24_txpower_t;
+
+enum si24_event_type_t {
+    EV_RX_COMPLETE = 0,
+    EV_TX_COMPLETE,
+    EV_TX_FULL,
+    EV_RX_EMPTY,
+    EV_ERR_TIMEOUT,
+    EV_ERR_BUS,
+    EV_ERR_MAX_RETRIES,
+    EV_ERR_CRC,
+    EV_ERR_CONFIG
+};
+
+typedef enum si24_event_type_t si24_event_type_t;
+
+union si24_event_t {
+       enum si24_event_type_t type;
+       struct error_t {
+               enum si24_event_type_t _type;
+               const char *file;
+               const char *func;
+               const char *msg;
+               int line;
+       } error;
 };
 
-typedef enum si24_event_t si24_event_t;
+typedef union si24_event_t si24_event_t;
 
 /* low level IO control */
 typedef struct {
-    size_t (*read)(unsigned char* buf, size_t size);
-    size_t (*write)(const unsigned char* buf, size_t size);
+    int (*write_and_read)(unsigned char *data, size_t sz);
+    void (*chip_enable)(unsigned val);
 } si24_ioctl_t;
 
 typedef struct {
-    si24_type_t type;
+    si24_mode_t mode;
     unsigned enable_ack;
+    unsigned non_blocking;
+    unsigned enable_crc;
+    unsigned enable_dynpd;
     si24_crc_t crc;
     si24_ioctl_t *ioctl;
-    unsigned msg_len;
+    si24_speed_t speed;
+    si24_txpower_t txpwr;
+    unsigned payload;
+    unsigned timeout; /* 1: 250 us, 15: 4000 us */
+    unsigned retries; /* 1 to 15 */
+    unsigned char mac_addr[5];
 } si24_opts_t;
 
 /* private data structure */
@@ -63,8 +122,8 @@ typedef void (*si24_event_handler_t)(si24_t* si24, si24_event_t* event);
 
 extern si24_t* si24_init(const si24_opts_t* si24opts, si24_event_handler_t eh);
 extern void si24_free(si24_t* si24);
-extern void si24_send(si24_t* si24, const char* buf, size_t size);
-extern void si24_recv(si24_t* si24, char* buf, size_t size);
+extern size_t si24_send(si24_t* si24, const unsigned char * buf, size_t size);
+extern size_t si24_recv(si24_t* si24, unsigned char * buf, size_t size);
 extern void si24_reset(si24_t* si24);
 
 #if defined(__cplusplus)