Change license to 2019

MaJerle · Dec 28, 2019 · 5ab4c37 · 5ab4c37
1 parent 07bdb8c
commit 5ab4c37
Show file tree

Hide file tree

Showing 8 changed files with 69 additions and 31 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -19,7 +19,7 @@
 # Run doxygen first
 # read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
 # if read_the_docs_build:
-subprocess.call('doxygen doxy_ow.doxy', shell=True)
+subprocess.call('doxygen doxyfile.doxy', shell=True)
 # -- Project information -----------------------------------------------------
 
 project = 'OneWire UART'
@@ -79,7 +79,7 @@
     'includehidden': True,
     'titles_only': False
 }
-html_logo = 'static/images/logo_tm.png'
+html_logo = 'static/images/logo.svg'
 github_url = 'https://github.com/MaJerle/onewire-uart'
 
 # Add any paths that contain custom static files (such as style sheets) here,

diff --git a/docs/doxy_ow.doxy → docs/doxyfile.doxy b/docs/doxy_ow.doxy → docs/doxyfile.doxy
diff --git a/docs/static/css/common.css b/docs/static/css/common.css
diff --git a/docs/static/images/logo b/docs/static/images/logo
@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2019-12-28T11:38:25.821Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36" etag="G9juCOhLi_KlLaVupHoj" version="12.3.2" type="device" pages="1"><diagram id="FREXYNdFMBb21ydttZkC" name="Page-1">7Zhdb5swFIZ/DZedAANhl2uSdTeVKqXS1qvJwSdg1eDIMU2yXz8TbMD5aJIJ0UzqVTiv7WP8vCdHFg4a55sHgZfZIyfAHN8lGwdNHN/3XD9QP5WyrZUwRrWQCkr0pFaY0T9gVmq1pARW1kTJOZN0aYsJLwpIpKVhIfjanrbgzN51iVM4EGYJZofqT0pkVqtx6Lb6D6BpZnb2XD2SYzNZC6sME77uSGjqoLHgXNZP+WYMrIJnuNTrvp8YbV5MQCEvWeC+FM+T5ygry0fvdUoffpMxuTNp3jAr9Yn128qtQSB4WRCosngOul9nVMJsiZNqdK1MV1omc6aHV1Lw1waVOuT9gjI25oyLXTZEMMSLpJnZGYmSGOYLNaJfCYSEzcnDeg1CVXvAc5Biq6boBcjUjy47L9LxujXRSFnHP+Mr1mWTNplbsupBw70GtD846BBiEhwDHftzFEX9gPZHNujRR3N2h+a8iBNIjhb0PA4DddB+OKMbK+jwPGcoyLeqBauo4AW8x7WqRtuWOhuQg/Z8lliHSPgOEQEMS/pmpz+GSe/wxKna+LQhwR7pFS9FAnpVty/vJUKjM4kkFinIg0Q715pj/7uRUe9GKoPE9pcK3C+hCV/07F0wqY7uNtFWR7duOXL7snw/kT+s5aNPyy+1PDjRdq+2fD/RwP/yr5+WX9rYo54sP0g0sOXeBX/zq65C3YuPrhC7LFBPd504tMCZsOM/OuL/fhPt7arjxf8ryMAG6Y0+muQFbegmSSJ/MJIqbD8K1L2g/bSCpn8B</diagram></mxfile>
diff --git a/docs/static/images/logo.svg b/docs/static/images/logo.svg
diff --git a/onewire_uart/src/include/ow/ow.h b/onewire_uart/src/include/ow/ow.h
@@ -80,10 +80,44 @@ typedef struct {
  * \brief           1-Wire low-level driver structure
  */
 typedef struct {
-    uint8_t (*init)(void* arg);                 /*!< Initialize low-level driver */
-    uint8_t (*deinit)(void* arg);               /*!< Deinit low-level driver */
-    uint8_t (*set_baudrate)(uint32_t baud, void* arg);  /*!< Set uart baudrate */
-    uint8_t (*tx_rx)(const uint8_t* tx, uint8_t* rx, size_t len, void* arg);    /* Exchange the data over UART port */
+    /**
+     * \brief       Initialize low-level driver
+     * \param[in]   arg: Custom argument passed to \ref ow_init function
+     * \return      `1` on success, `0` otherwise
+     */
+    uint8_t (*init)(void* arg);
+
+    /**
+     * \brief       De-initialize low-level driver
+     * \param[in]   arg: Custom argument passed to \ref ow_init function
+     * \return      `1` on success, `0` otherwise
+     */
+    uint8_t (*deinit)(void* arg);
+
+    /**
+     * \brief       Set UART baudrate
+     * \param[in]   baud: Baudrate to set in units of bauds, normally `9600` or `115200`
+     * \param[in]   arg: Custom argument passed to \ref ow_init function
+     * \return      `1` on success, `0` otherwise
+     */
+    uint8_t (*set_baudrate)(uint32_t baud, void* arg);
+
+    /**
+     * \brief       Transmit and receive bytes over UART hardware (or custom implementation)
+     *
+     * Bytes array for `tx` is already prepared to be directly transmitted over UART hardware,
+     * no data manipulation is necessary.
+     *
+     * At the same time, library must read received data on RX port and put it to `rx` data array,
+     * one by one, up to `len` number of bytes
+     *
+     * \param[in]   tx: Data to transmit over UART
+     * \param[out]  rx: Array to write received data to
+     * \param[in]   len: Number of bytes to exchange
+     * \param[in]   arg: Custom argument passed to \ref ow_init function
+     * \return      `1` on success, `0` otherwise
+     */
+    uint8_t (*tx_rx)(const uint8_t* tx, uint8_t* rx, size_t len, void* arg);
 } ow_ll_drv_t;
 
 /**

diff --git a/onewire_uart/src/system/ow_ll_stm32.c b/onewire_uart/src/system/ow_ll_stm32.c
@@ -41,25 +41,25 @@
 
 #if !__DOXYGEN__
 
-static uint8_t ow_ll_init(void* arg);
-static uint8_t ow_ll_deinit(void* arg);
-static uint8_t ow_ll_set_baudrate(uint32_t baud, void* arg);
-static uint8_t ow_ll_transmit_receive(const uint8_t* tx, uint8_t* rx, size_t len, void* arg);
+static uint8_t init(void* arg);
+static uint8_t deinit(void* arg);
+static uint8_t set_baudrate(uint32_t baud, void* arg);
+static uint8_t transmit_receive(const uint8_t* tx, uint8_t* rx, size_t len, void* arg);
 
 /* STM32 LL driver for OW */
 const ow_ll_drv_t
 ow_ll_drv_stm32 = {
-    .init = ow_ll_init,
-    .deinit = ow_ll_deinit,
-    .set_baudrate = ow_ll_set_baudrate,
-    .tx_rx = ow_ll_transmit_receive,
+    .init = init,
+    .deinit = deinit,
+    .set_baudrate = set_baudrate,
+    .tx_rx = transmit_receive,
 };
 
 static LL_USART_InitTypeDef
 usart_init;
 
 static uint8_t
-ow_ll_init(void* arg) {
+init(void* arg) {
     LL_GPIO_InitTypeDef gpio_init;
 
     /* Peripheral clock enable */
@@ -103,14 +103,14 @@ ow_ll_init(void* arg) {
 }
 
 static uint8_t
-ow_ll_deinit(void* arg) {
+deinit(void* arg) {
     LL_USART_DeInit(ONEWIRE_USART);
     OW_UNUSED(arg);
     return 1;
 }
 
 static uint8_t
-ow_ll_set_baudrate(uint32_t baud, void* arg) {
+set_baudrate(uint32_t baud, void* arg) {
     usart_init.BaudRate = baud;
     LL_USART_Init(ONEWIRE_USART, &usart_init);
     LL_USART_ConfigAsyncMode(ONEWIRE_USART);
@@ -120,7 +120,7 @@ ow_ll_set_baudrate(uint32_t baud, void* arg) {
 }
 
 static uint8_t
-ow_ll_transmit_receive(const uint8_t* tx, uint8_t* rx, size_t len, void* arg) {
+transmit_receive(const uint8_t* tx, uint8_t* rx, size_t len, void* arg) {
     const uint8_t* t = tx;
     uint8_t* r = rx;
 

diff --git a/onewire_uart/src/system/ow_ll_win32.c b/onewire_uart/src/system/ow_ll_win32.c
@@ -38,25 +38,25 @@
 #if !__DOXYGEN__
 
 /* Function prototypes */
-static uint8_t ow_ll_init(void* arg);
-static uint8_t ow_ll_deinit(void* arg);
-static uint8_t ow_ll_set_baudrate(uint32_t baud, void* arg);
-static uint8_t ow_ll_transmit_receive(const uint8_t* tx, uint8_t* rx, size_t len, void* arg);
+static uint8_t init(void* arg);
+static uint8_t deinit(void* arg);
+static uint8_t set_baudrate(uint32_t baud, void* arg);
+static uint8_t transmit_receive(const uint8_t* tx, uint8_t* rx, size_t len, void* arg);
 
 /* Win 32 LL driver for OW */
 const ow_ll_drv_t
 ow_ll_drv_win32 = {
-    .init = ow_ll_init,
-    .deinit = ow_ll_deinit,
-    .set_baudrate = ow_ll_set_baudrate,
-    .tx_rx = ow_ll_transmit_receive,
+    .init = init,
+    .deinit = deinit,
+    .set_baudrate = set_baudrate,
+    .tx_rx = transmit_receive,
 };
 
 static HANDLE com_port;
 static DCB dcb = { 0 };
 
 static uint8_t
-ow_ll_init(void* arg) {
+init(void* arg) {
     dcb.DCBlength = sizeof(dcb);
 
     /* Open virtual file as read/write */
@@ -102,14 +102,14 @@ ow_ll_init(void* arg) {
 }
 
 uint8_t
-ow_ll_deinit(void* arg) {
+deinit(void* arg) {
     /* Disable UART peripheral */
 
     return 1;
 }
 
 uint8_t
-ow_ll_set_baudrate(uint32_t baud, void* arg) {
+set_baudrate(uint32_t baud, void* arg) {
     /* Configure UART to selected baudrate */
     dcb.BaudRate = baud;
 
@@ -123,7 +123,7 @@ ow_ll_set_baudrate(uint32_t baud, void* arg) {
 }
 
 uint8_t
-ow_ll_transmit_receive(const uint8_t* tx, uint8_t* rx, size_t len, void* arg) {
+transmit_receive(const uint8_t* tx, uint8_t* rx, size_t len, void* arg) {
     /* Perform data exchange */
     size_t read = 0;
     DWORD br;