git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2167 35acf78f-673a-0410-8e92-d51de3d6d3f4

9 files changed, 44 insertions, 17 deletions

diff --git a/os/hal/templates/adc_lld.h b/os/hal/templates/adc_lld.h
index a36fc205f..d969b24e0 100644
--- a/os/hal/templates/adc_lld.h
+++ b/os/hal/templates/adc_lld.h
@@ -72,6 +72,8 @@ typedef void (*adccallback_t)(adcsample_t *buffer, size_t n);
  * @brief   Conversion group configuration structure.

  * @details This implementation-dependent structure describes a conversion

  *          operation.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

   /**

@@ -87,6 +89,8 @@ typedef struct {
 

 /**

  * @brief   Driver configuration structure.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  * @note    It could be empty on some architectures.

  */

 typedef struct {

@@ -95,6 +99,8 @@ typedef struct {
 

 /**

  * @brief   Structure representing an ADC driver.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

   /**

diff --git a/os/hal/templates/can_lld.h b/os/hal/templates/can_lld.h
index 3049d8a94..afca6821e 100644
--- a/os/hal/templates/can_lld.h
+++ b/os/hal/templates/can_lld.h
@@ -130,6 +130,8 @@ typedef struct {
 

 /**

  * @brief   CAN filter.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  * @note    It could not be present on some architectures.

  */

 typedef struct {

@@ -137,6 +139,8 @@ typedef struct {
 

 /**

  * @brief   Driver configuration structure.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  * @note    It could be empty on some architectures.

  */

 typedef struct {

@@ -144,6 +148,8 @@ typedef struct {
 

 /**

  * @brief   Structure representing an CAN driver.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

   /**

diff --git a/os/hal/templates/i2c_lld.h b/os/hal/templates/i2c_lld.h
index 3a2ceb4aa..77c67cc07 100644
--- a/os/hal/templates/i2c_lld.h
+++ b/os/hal/templates/i2c_lld.h
@@ -56,7 +56,8 @@ typedef void (*i2ccallback_t)(I2CDriver *i2cp, i2cstatus_t sts);
 

 /**

  * @brief   Driver configuration structure.

- * @note    It could be empty on some architectures.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

   /** @brief I2C bus bit rate.*/

@@ -66,6 +67,8 @@ typedef struct {
 

 /**

  * @brief   Structure representing an I2C driver.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

   /** @brief Driver state.*/

diff --git a/os/hal/templates/mac_lld.h b/os/hal/templates/mac_lld.h
index 37b6d0ae9..ecd1b4339 100644
--- a/os/hal/templates/mac_lld.h
+++ b/os/hal/templates/mac_lld.h
@@ -69,6 +69,8 @@
 

 /**

  * @brief   Structure representing a MAC driver.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

   Semaphore             md_tdsem;       /**< Transmit semaphore.        */

@@ -81,6 +83,8 @@ typedef struct {
 

 /**

  * @brief   Structure representing a transmit descriptor.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

   size_t                td_offset;      /**< Current write offset.      */

@@ -90,6 +94,8 @@ typedef struct {
 

 /**

  * @brief   Structure representing a receive descriptor.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

   size_t                rd_offset;      /**< Current read offset.       */

diff --git a/os/hal/templates/pal_lld.h b/os/hal/templates/pal_lld.h
index b71b9d96e..dddc58e77 100644
--- a/os/hal/templates/pal_lld.h
+++ b/os/hal/templates/pal_lld.h
@@ -44,18 +44,12 @@
  *          system startup time in order to initialized the digital I/O

  *          subsystem. This represents only the initial setup, specific pads

  *          or whole ports can be reprogrammed at later time.

- * @note    This structure content is architecture dependent. The nome should

- *          be changed to include the architecture name following this

- *          pattern:<br>

- *          - [ARCH][CELL]Config.

- *          .

- *          As example:<br>

- *          - MSP430DIOConfig.

- *          .

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

 

-} GenericConfig;

+} PALConfig;

 

 /**

  * @brief   Width, in bits, of an I/O port.

diff --git a/os/hal/templates/pwm_lld.h b/os/hal/templates/pwm_lld.h
index 76a691a55..b74582d9d 100644
--- a/os/hal/templates/pwm_lld.h
+++ b/os/hal/templates/pwm_lld.h
@@ -63,6 +63,8 @@ typedef uint16_t pwmcnt_t;
 

 /**

  * @brief   Driver configuration structure.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  * @note    It could be empty on some architectures.

  */

 typedef struct {

@@ -71,6 +73,8 @@ typedef struct {
 

 /**

  * @brief   Structure representing an PWM driver.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

   /**

diff --git a/os/hal/templates/serial_lld.h b/os/hal/templates/serial_lld.h
index 2a2abb582..fe05d864b 100644
--- a/os/hal/templates/serial_lld.h
+++ b/os/hal/templates/serial_lld.h
@@ -55,9 +55,8 @@ typedef uint8_t sdflags_t;
  * @brief   Generic Serial Driver configuration structure.

  * @details An instance of this structure must be passed to @p sdStart()

  *          in order to configure and start a serial driver operations.

- * @note    This structure content is architecture dependent, each driver

- *          implementation defines its own version and the custom static

- *          initializers.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

 

diff --git a/os/hal/templates/spi_lld.h b/os/hal/templates/spi_lld.h
index 11409d9eb..67ca25b02 100644
--- a/os/hal/templates/spi_lld.h
+++ b/os/hal/templates/spi_lld.h
@@ -48,13 +48,17 @@
 

 /**

  * @brief   Driver configuration structure.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

 

 } SPIConfig;

 

 /**

- * @brief   Structure representing a SPI driver.

+ * @brief   Structure representing an SPI driver.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

   /**

diff --git a/os/hal/templates/uart_lld.h b/os/hal/templates/uart_lld.h
index a1f9b9d38..ba55d723b 100644
--- a/os/hal/templates/uart_lld.h
+++ b/os/hal/templates/uart_lld.h
@@ -53,8 +53,10 @@ typedef uint32_t uartflags_t;
 

 /**

  * @brief   Structure representing an UART driver.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

-typedef struct _UARTDriver UARTDriver;

+typedef struct UARTDriver UARTDriver;

 

 /**

  * @brief   Generic UART notification callback type.

@@ -81,7 +83,8 @@ typedef void (*uartecb_t)(UARTDriver *uartp, uartflags_t e);
 

 /**

  * @brief   Driver configuration structure.

- * @note    It could be empty on some architectures.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

 typedef struct {

   /** @brief End of transmission buffer callback.*/

@@ -99,8 +102,10 @@ typedef struct {
 

 /**

  * @brief   Structure representing an UART driver.

+ * @note    Implementations may extend this structure to contain more,

+ *          architecture dependent, fields.

  */

-struct _UARTDriver {

+struct UARTDriver {

   /**

    * @brief Driver state.

    */