diff options
| author | Giovanni Di Sirio <gdisirio@gmail.com> | 2016-01-03 11:04:07 +0000 |
|---|---|---|
| committer | Giovanni Di Sirio <gdisirio@gmail.com> | 2016-01-03 11:04:07 +0000 |
| commit | 25673ac6de8dc912b2d9a5c053205cbec7138dd4 (patch) | |
| tree | a95a093b88d865c75196ce9979f77829075c5300 /os | |
| parent | a02c36fc6598a0120dc5f637c28b2981a3954dfd (diff) | |
| download | ChibiOS-25673ac6de8dc912b2d9a5c053205cbec7138dd4.tar.gz ChibiOS-25673ac6de8dc912b2d9a5c053205cbec7138dd4.tar.bz2 ChibiOS-25673ac6de8dc912b2d9a5c053205cbec7138dd4.zip | |
Documentation-related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@8674 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os')
| -rw-r--r-- | os/hal/templates/halconf.h | 30 |
1 files changed, 23 insertions, 7 deletions
diff --git a/os/hal/templates/halconf.h b/os/hal/templates/halconf.h index da13911e1..59943b2c4 100644 --- a/os/hal/templates/halconf.h +++ b/os/hal/templates/halconf.h @@ -325,7 +325,7 @@ * @brief Serial buffers size.
* @details Configuration parameter, you can change the depth of the queue
* buffers depending on the requirements of your application.
- * @note The default is 64 bytes for both the transmission and receive
+ * @note The default is 16 bytes for both the transmission and receive
* buffers.
*/
#if !defined(SERIAL_BUFFERS_SIZE) || defined(__DOXYGEN__)
@@ -344,12 +344,20 @@ * @brief Serial over USB buffers size.
* @details Configuration parameter, the buffer size must be a multiple of
* the USB data endpoint maximum packet size.
- * @note The default is 64 bytes for both the transmission and receive
+ * @note The default is 256 bytes for both the transmission and receive
* buffers.
*/
#if !defined(SERIAL_USB_BUFFERS_SIZE) || defined(__DOXYGEN__)
#define SERIAL_USB_BUFFERS_SIZE 256
#endif
+
+/**
+ * @brief Serial over USB number of buffers.
+ * @note The default is 2 buffers.
+ */
+#if !defined(SERIAL_USB_BUFFERS_NUMBER) || defined(__DOXYGEN__)
+#define SERIAL_USB_BUFFERS_NUMBER 2
+#endif
/** @} */
/*===========================================================================*/
@@ -377,7 +385,10 @@ /** @} */
/*===========================================================================*/
-/* UART driver related settings. */
+/**
+ * @name UART driver related setting
+ * @{
+ */
/*===========================================================================*/
/**
@@ -385,7 +396,7 @@ * @note Disabling this option saves both code and data space.
*/
#if !defined(UART_USE_WAIT) || defined(__DOXYGEN__)
-#define UART_USE_WAIT FALSE
+#define UART_USE_WAIT TRUE
#endif
/**
@@ -393,11 +404,15 @@ * @note Disabling this option saves both code and data space.
*/
#if !defined(UART_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
-#define UART_USE_MUTUAL_EXCLUSION FALSE
+#define UART_USE_MUTUAL_EXCLUSION TRUE
#endif
+/** @} */
/*===========================================================================*/
-/* USB driver related settings. */
+/**
+ * @name USB driver related setting
+ * @{
+ */
/*===========================================================================*/
/**
@@ -405,8 +420,9 @@ * @note Disabling this option saves both code and data space.
*/
#if !defined(USB_USE_WAIT) || defined(__DOXYGEN__)
-#define USB_USE_WAIT FALSE
+#define USB_USE_WAIT TRUE
#endif
+/** @} */
#endif /* _HALCONF_H_ */
|