From e442d39b3efa6acbaecbc396b39a3db3171e6a72 Mon Sep 17 00:00:00 2001
From: Giovanni Di Sirio <gdisirio@gmail.com>
Date: Fri, 28 Sep 2018 09:30:06 +0000
Subject: Added notes, removed unused types.

git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@12303 110e8d01-0319-4d1e-a829-52ad28d1bb01
---
 os/hal/include/hal_sio.h       | 15 +++++----------
 os/hal/templates/hal_sio_lld.h | 12 ++++++++----
 2 files changed, 13 insertions(+), 14 deletions(-)

diff --git a/os/hal/include/hal_sio.h b/os/hal/include/hal_sio.h
index 6999574eb..d72d57256 100644
--- a/os/hal/include/hal_sio.h
+++ b/os/hal/include/hal_sio.h
@@ -81,22 +81,17 @@ typedef enum {
   SIO_READY = 2                     /**< Ready.                             */
 } siostate_t;
 
-/**
- * @brief   Type of a function writing a frame received by SIO.
- */
-typedef msg_t (*sioput_t)(void *p, uint8_t b);
-
-/**
- * @brief   Type of a function reading a frame to be transmitted by SIO.
- */
-typedef msg_t (*sioget_t)(void *p);
-
 #include "hal_sio_lld.h"
 
 /*===========================================================================*/
 /* Driver macros.                                                            */
 /*===========================================================================*/
 
+/**
+ * @brief   Returns the current set of flags and clears it.
+ */
+#define sioGetFlagsX(siop) sio_lld_get_flags(siop)
+
 /**
  * @brief   Determines the state of the RX FIFO.
  *
diff --git a/os/hal/templates/hal_sio_lld.h b/os/hal/templates/hal_sio_lld.h
index c78de4da9..a54df4b70 100644
--- a/os/hal/templates/hal_sio_lld.h
+++ b/os/hal/templates/hal_sio_lld.h
@@ -86,20 +86,24 @@ typedef void (*sioecb_t)(SIODriver *siop, sioflags_t e);
 struct hal_sio_config {
   /**
    * @brief   Receive buffer filled callback.
+   * @note    Can be @p NULL.
    */
-  siocb_t                  rxne_cb;
+  siocb_t                   rxne_cb;
   /**
    * @brief   End of transmission buffer callback.
+   * @note    Can be @p NULL.
    */
-  siocb_t                  txnf_cb;
+  siocb_t                   txnf_cb;
   /**
    * @brief   Physical end of transmission callback.
+   * @note    Can be @p NULL.
    */
-  siocb_t                  txend_cb;
+  siocb_t                   txend_cb;
   /**
    * @brief   Receive event callback.
+   * @note    Can be @p NULL.
    */
-  sioecb_t                 rxevt_cb;
+  siocb_t                   rxevt_cb;
   /* End of the mandatory fields.*/
 };
 
-- 
cgit v1.2.3