GPT driver model, STM32 GPT driver implementation, not tested, documentation not done yet.

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

8 files changed, 916 insertions, 14 deletions

diff --git a/os/hal/templates/adc_lld.c b/os/hal/templates/adc_lld.c
index 54622beb7..6c541f557 100644
--- a/os/hal/templates/adc_lld.c
+++ b/os/hal/templates/adc_lld.c
@@ -83,6 +83,10 @@ void adc_lld_start(ADCDriver *adcp) {
  */

 void adc_lld_stop(ADCDriver *adcp) {

 

+  if (adcp->ad_state == ADC_READY) {

+    /* Clock de-activation.*/

+

+  }

 }

 

 /**

diff --git a/os/hal/templates/gpt_lld.c b/os/hal/templates/gpt_lld.c
new file mode 100644
index 000000000..edb6c5ba1
--- /dev/null
+++ b/os/hal/templates/gpt_lld.c
@@ -0,0 +1,134 @@
+/*

+    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.

+

+    This file is part of ChibiOS/RT.

+

+    ChibiOS/RT 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 3 of the License, or

+    (at your option) any later version.

+

+    ChibiOS/RT 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, see <http://www.gnu.org/licenses/>.

+*/

+

+/**

+ * @file    templates/gpt_lld.c

+ * @brief   GPT Driver subsystem low level driver source template.

+ *

+ * @addtogroup GPT

+ * @{

+ */

+

+#include "ch.h"

+#include "hal.h"

+

+#if HAL_USE_GPT || defined(__DOXYGEN__)

+

+/*===========================================================================*/

+/* Driver exported variables.                                                */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver local variables.                                                   */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver local functions.                                                   */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver interrupt handlers.                                                */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver exported functions.                                                */

+/*===========================================================================*/

+

+/**

+ * @brief   Low level GPT driver initialization.

+ *

+ * @notapi

+ */

+void gpt_lld_init(void) {

+

+}

+

+/**

+ * @brief   Configures and activates the GPT peripheral.

+ *

+ * @param[in] gptp      pointer to the @p GPTDriver object

+ *

+ * @notapi

+ */

+void gpt_lld_start(GPTDriver *gptp) {

+  uint16_t psc;

+

+  if (gptp->state == GPT_STOP) {

+    /* Clock activation.*/

+

+  }

+  /* Configuration.*/

+}

+

+/**

+ * @brief   Deactivates the GPT peripheral.

+ *

+ * @param[in] gptp      pointer to the @p GPTDriver object

+ *

+ * @notapi

+ */

+void gpt_lld_stop(GPTDriver *gptp) {

+

+  if (gptp->state == GPT_READY) {

+    /* Clock de-activation.*/

+

+  }

+}

+

+/**

+ * @brief   Starts the timer in continuous mode.

+ *

+ * @param[in] gptp      pointer to the @p GPTDriver object

+ * @param[in] period    period in ticks

+ *

+ * @notapi

+ */

+void gpt_lld_start_timer(GPTDriver *gptp, gptcnt_t period) {

+

+}

+

+/**

+ * @brief   Stops the timer.

+ *

+ * @param[in] gptp      pointer to the @p GPTDriver object

+ *

+ * @notapi

+ */

+void gpt_lld_stop_timer(GPTDriver *gptp) {

+

+}

+

+/**

+ * @brief   Starts the timer in one shot mode and waits for completion.

+ * @details This function specifically polls the timer waiting for completion

+ *          in order to not have extra delays caused by interrupt servicing,

+ *          this function is only recommended for short delays.

+ *

+ * @param[in] gptp      pointer to the @p GPTDriver object

+ * @param[in] interval  time interval in ticks

+ *

+ * @notapi

+ */

+void gpt_lld_polled_delay(GPTDriver *gptp, gptcnt_t interval) {

+

+}

+

+#endif /* HAL_USE_GPT */

+

+/** @} */

diff --git a/os/hal/templates/gpt_lld.h b/os/hal/templates/gpt_lld.h
new file mode 100644
index 000000000..6f8d67d66
--- /dev/null
+++ b/os/hal/templates/gpt_lld.h
@@ -0,0 +1,130 @@
+/*

+    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.

+

+    This file is part of ChibiOS/RT.

+

+    ChibiOS/RT 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 3 of the License, or

+    (at your option) any later version.

+

+    ChibiOS/RT 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, see <http://www.gnu.org/licenses/>.

+*/

+

+/**

+ * @file    templates/gpt_lld.h

+ * @brief   GPT Driver subsystem low level driver header template.

+ *

+ * @addtogroup GPT

+ * @{

+ */

+

+#ifndef _GPT_LLD_H_

+#define _GPT_LLD_H_

+

+#if HAL_USE_GPT || defined(__DOXYGEN__)

+

+/*===========================================================================*/

+/* Driver constants.                                                         */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver pre-compile time settings.                                         */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Derived constants and error checks.                                       */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver data structures and types.                                         */

+/*===========================================================================*/

+

+/**

+ * @brief   GPT frequency type.

+ */

+typedef uint32_t gptfreq_t;

+

+/**

+ * @brief   GPT counter type.

+ */

+typedef uint16_t gptcnt_t;

+

+/**

+ * @brief   Type of a structure representing a GPT driver.

+ */

+typedef struct GPTDriver GPTDriver;

+

+/**

+ * @brief   GPT notification callback type.

+ *

+ * @param[in] gptp      pointer to a @p GPTDriver object

+ */

+typedef void (*gptcallback_t)(GPTDriver *gptp);

+

+/**

+ * @brief   Driver configuration structure.

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

+ */

+typedef struct {

+  /**

+   * @brief   Timer clock in Hz.

+   * @note    The low level can use assertions in order to catch invalid

+   *          frequency specifications.

+   */

+  gptfreq_t                 frequency;

+  /**

+   * @brief   Timer callback pointer.

+   * @note    This callback is invoked on GPT counter events.

+   */

+  gptcallback_t             callback;

+  /* End of the mandatory fields.*/

+} GPTConfig;

+

+/**

+ * @brief   Structure representing a GPT driver.

+ */

+struct GPTDriver {

+  /**

+   * @brief Driver state.

+   */

+  gptstate_t                state;

+  /**

+   * @brief Current configuration data.

+   */

+  const GPTConfig           *config;

+  /* End of the mandatory fields.*/

+};

+

+/*===========================================================================*/

+/* Driver macros.                                                            */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* External declarations.                                                    */

+/*===========================================================================*/

+

+#ifdef __cplusplus

+extern "C" {

+#endif

+  void gpt_lld_init(void);

+  void gpt_lld_start(GPTDriver *gptp);

+  void gpt_lld_stop(GPTDriver *gptp);

+  void gpt_lld_start_timer(GPTDriver *gptp, gptcnt_t interval);

+  void gpt_lld_stop_timer(GPTDriver *gptp);

+  void gpt_lld_polled_delay(GPTDriver *gptp, gptcnt_t interval);

+#ifdef __cplusplus

+}

+#endif

+

+#endif /* HAL_USE_GPT */

+

+#endif /* _GPT_LLD_H_ */

+

+/** @} */

diff --git a/os/hal/templates/meta/driver.c b/os/hal/templates/meta/driver.c
index f75c5d380..52d448126 100644
--- a/os/hal/templates/meta/driver.c
+++ b/os/hal/templates/meta/driver.c
@@ -67,8 +67,8 @@ void xxxInit(void) {
  */

 void xxxObjectInit(XXXDriver *xxxp) {

 

-  xxxp->xxx_state    = XXX_STOP;

-  xxxp->xxx_config   = NULL;

+  xxxp->state  = XXX_STOP;

+  xxxp->config = NULL;

 }

 

 /**

@@ -84,12 +84,11 @@ void xxxStart(XXXDriver *xxxp, const XXXConfig *config) {
   chDbgCheck((xxxp != NULL) && (config != NULL), "xxxStart");

 

   chSysLock();

-  chDbgAssert((xxxp->xxx_state == XXX_STOP) || (xxxp->xxx_state == XXX_READY),

-              "xxxStart(), #1",

-              "invalid state");

-  xxxp->xxx_config = config;

+  chDbgAssert((xxxp->state == XXX_STOP) || (xxxp->state == XXX_READY),

+              "xxxStart(), #1", "invalid state");

+  xxxp->config = config;

   xxx_lld_start(xxxp);

-  xxxp->xxx_state = XXX_READY;

+  xxxp->state = XXX_READY;

   chSysUnlock();

 }

 

@@ -105,11 +104,10 @@ void xxxStop(XXXDriver *xxxp) {
   chDbgCheck(xxxp != NULL, "xxxStop");

 

   chSysLock();

-  chDbgAssert((xxxp->xxx_state == XXX_STOP) || (xxxp->xxx_state == XXX_READY),

-              "xxxStop(), #1",

-              "invalid state");

+  chDbgAssert((xxxp->state == XXX_STOP) || (xxxp->state == XXX_READY),

+              "xxxStop(), #1", "invalid state");

   xxx_lld_stop(xxxp);

-  xxxp->xxx_state = XXX_STOP;

+  xxxp->state = XXX_STOP;

   chSysUnlock();

 }

 

diff --git a/os/hal/templates/meta/driver_lld.c b/os/hal/templates/meta/driver_lld.c
index 051dfac03..c548ccd8a 100644
--- a/os/hal/templates/meta/driver_lld.c
+++ b/os/hal/templates/meta/driver_lld.c
@@ -68,7 +68,7 @@ void xxx_lld_init(void) {
  */

 void xxx_lld_start(XXXDriver *xxxp) {

 

-  if (xxxp->xxx_state == XXX_STOP) {

+  if (xxxp->state == XXX_STOP) {

     /* Clock activation.*/

   }

   /* Configuration.*/

@@ -83,6 +83,10 @@ void xxx_lld_start(XXXDriver *xxxp) {
  */

 void xxx_lld_stop(XXXDriver *xxxp) {

 

+  if (xxxp->state == XXX_READY) {

+    /* Clock deactivation.*/

+

+  }

 }

 

 #endif /* HAL_USE_XXX */

diff --git a/os/hal/templates/meta/driver_lld.h b/os/hal/templates/meta/driver_lld.h
index 7d75bbaea..a30b54921 100644
--- a/os/hal/templates/meta/driver_lld.h
+++ b/os/hal/templates/meta/driver_lld.h
@@ -67,11 +67,11 @@ struct XXXDriver {
   /**

    * @brief Driver state.

    */

-  xxxstate_t                xxx_state;

+  xxxstate_t                state;

   /**

    * @brief Current configuration data.

    */

-  const XXXConfig           *xxx_config;

+  const XXXConfig           *config;

   /* End of the mandatory fields.*/

 };

 

diff --git a/os/hal/templates/usb_lld.c b/os/hal/templates/usb_lld.c
new file mode 100644
index 000000000..d2750d2e5
--- /dev/null
+++ b/os/hal/templates/usb_lld.c
@@ -0,0 +1,327 @@
+/*

+    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.

+

+    This file is part of ChibiOS/RT.

+

+    ChibiOS/RT 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 3 of the License, or

+    (at your option) any later version.

+

+    ChibiOS/RT 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, see <http://www.gnu.org/licenses/>.

+*/

+

+/**

+ * @file    templates/usb_lld.c

+ * @brief   USB Driver subsystem low level driver source template.

+ *

+ * @addtogroup USB

+ * @{

+ */

+

+#include "ch.h"

+#include "hal.h"

+

+#if HAL_USE_USB || defined(__DOXYGEN__)

+

+/*===========================================================================*/

+/* Driver exported variables.                                                */

+/*===========================================================================*/

+

+/**

+ * @brief   EP0 state.

+ * @note    It is an union because IN and OUT endpoints are never used at the

+ *          same time for EP0.

+ */

+static union {

+  /**

+   * @brief   IN EP0 state.

+   */

+  USBInEndpointState in;

+  /**

+   * @brief   OUT EP0 state.

+   */

+  USBOutEndpointState out;

+} ep0_state;

+

+/**

+ * @brief   EP0 initialization structure.

+ */

+static const USBEndpointConfig ep0config = {

+  USB_EP_MODE_TYPE_CTRL | USB_EP_MODE_TRANSACTION,

+  _usb_ep0in,

+  _usb_ep0out,

+  0x40,

+  0x40,

+  &ep0_state.in,

+  &ep0_state.out

+};

+

+/*===========================================================================*/

+/* Driver local variables.                                                   */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver local functions.                                                   */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver interrupt handlers.                                                */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver exported functions.                                                */

+/*===========================================================================*/

+

+/**

+ * @brief   Low level USB driver initialization.

+ *

+ * @notapi

+ */

+void usb_lld_init(void) {

+

+}

+

+/**

+ * @brief   Configures and activates the USB peripheral.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ *

+ * @notapi

+ */

+void usb_lld_start(USBDriver *usbp) {

+

+  if (usbp->state == USB_STOP) {

+    /* Clock activation.*/

+

+    /* Reset procedure enforced on driver start.*/

+    _usb_reset(usbp);

+  }

+  /* Configuration.*/

+}

+

+/**

+ * @brief   Deactivates the USB peripheral.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ *

+ * @notapi

+ */

+void usb_lld_stop(USBDriver *usbp) {

+

+  /* If in ready state then disables the USB clock.*/

+  if (usbp->state == USB_STOP) {

+

+  }

+}

+

+/**

+ * @brief   USB low level reset routine.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ *

+ * @notapi

+ */

+void usb_lld_reset(USBDriver *usbp) {

+

+  /* Post reset initialization.*/

+

+  /* EP0 initialization.*/

+  usbp->epc[0] = &ep0config;

+  usb_lld_init_endpoint(usbp, 0);

+}

+

+/**

+ * @brief   Sets the USB address.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ *

+ * @notapi

+ */

+void usb_lld_set_address(USBDriver *usbp) {

+

+}

+

+/**

+ * @brief   Enables an endpoint.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ *

+ * @notapi

+ */

+void usb_lld_init_endpoint(USBDriver *usbp, usbep_t ep) {

+

+}

+

+/**

+ * @brief   Disables all the active endpoints except the endpoint zero.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ *

+ * @notapi

+ */

+void usb_lld_disable_endpoints(USBDriver *usbp) {

+

+}

+

+/**

+ * @brief   Returns the status of an OUT endpoint.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ * @return              The endpoint status.

+ * @retval EP_STATUS_DISABLED The endpoint is not active.

+ * @retval EP_STATUS_STALLED  The endpoint is stalled.

+ * @retval EP_STATUS_ACTIVE   The endpoint is active.

+ *

+ * @notapi

+ */

+usbepstatus_t usb_lld_get_status_out(USBDriver *usbp, usbep_t ep) {

+

+}

+

+/**

+ * @brief   Returns the status of an IN endpoint.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ * @return              The endpoint status.

+ * @retval EP_STATUS_DISABLED The endpoint is not active.

+ * @retval EP_STATUS_STALLED  The endpoint is stalled.

+ * @retval EP_STATUS_ACTIVE   The endpoint is active.

+ *

+ * @notapi

+ */

+usbepstatus_t usb_lld_get_status_in(USBDriver *usbp, usbep_t ep) {

+

+}

+

+/**

+ * @brief   Reads a packet from the dedicated packet buffer.

+ * @pre     In order to use this function he endpoint must have been

+ *          initialized in packet mode.

+ * @post    The endpoint is ready to accept another packet.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ * @param[out] buf      buffer where to copy the packet data

+ * @param[in] n         maximum number of bytes to copy. This value must

+ *                      not exceed the maximum packet size for this endpoint.

+ * @return              The received packet size regardless the specified

+ *                      @p n parameter.

+ * @retval 0            Zero size packet received.

+ *

+ * @notapi

+ */

+size_t usb_lld_read_packet(USBDriver *usbp, usbep_t ep,

+                           uint8_t *buf, size_t n) {

+

+}

+

+/**

+ * @brief   Writes a packet to the dedicated packet buffer.

+ * @pre     In order to use this function he endpoint must have been

+ *          initialized in packet mode.

+ * @post    The endpoint is ready to transmit the packet.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ * @param[in] buf       buffer where to fetch the packet data

+ * @param[in] n         maximum number of bytes to copy. This value must

+ *                      not exceed the maximum packet size for this endpoint.

+ *

+ * @notapi

+ */

+void usb_lld_write_packet(USBDriver *usbp, usbep_t ep,

+                          const uint8_t *buf, size_t n) {

+

+}

+

+/**

+ * @brief   Starts a receive operation on an OUT endpoint.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ * @param[out] buf      buffer where to copy the endpoint data

+ * @param[in] n         maximum number of bytes to copy in the buffer

+ *

+ * @notapi

+ */

+void usb_lld_start_out(USBDriver *usbp, usbep_t ep,

+                       uint8_t *buf, size_t n) {

+

+}

+

+/**

+ * @brief   Starts a transmit operation on an IN endpoint.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ * @param[in] buf       buffer where to fetch the endpoint data

+ * @param[in] n         maximum number of bytes to copy

+ *

+ * @notapi

+ */

+void usb_lld_start_in(USBDriver *usbp, usbep_t ep,

+                      const uint8_t *buf, size_t n) {

+

+}

+

+/**

+ * @brief   Brings an OUT endpoint in the stalled state.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ *

+ * @notapi

+ */

+void usb_lld_stall_out(USBDriver *usbp, usbep_t ep) {

+

+}

+

+/**

+ * @brief   Brings an IN endpoint in the stalled state.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ *

+ * @notapi

+ */

+void usb_lld_stall_in(USBDriver *usbp, usbep_t ep) {

+

+}

+

+/**

+ * @brief   Brings an OUT endpoint in the active state.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ *

+ * @notapi

+ */

+void usb_lld_clear_out(USBDriver *usbp, usbep_t ep) {

+

+}

+

+/**

+ * @brief   Brings an IN endpoint in the active state.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ *

+ * @notapi

+ */

+void usb_lld_clear_in(USBDriver *usbp, usbep_t ep) {

+

+}

+

+#endif /* HAL_USE_USB */

+

+/** @} */

diff --git a/os/hal/templates/usb_lld.h b/os/hal/templates/usb_lld.h
new file mode 100644
index 000000000..254f6c5da
--- /dev/null
+++ b/os/hal/templates/usb_lld.h
@@ -0,0 +1,305 @@
+/*

+    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.

+

+    This file is part of ChibiOS/RT.

+

+    ChibiOS/RT 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 3 of the License, or

+    (at your option) any later version.

+

+    ChibiOS/RT 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, see <http://www.gnu.org/licenses/>.

+*/

+

+/**

+ * @file    templates/usb_lld.h

+ * @brief   USB Driver subsystem low level driver header template.

+ *

+ * @addtogroup USB

+ * @{

+ */

+

+#ifndef _USB_LLD_H_

+#define _USB_LLD_H_

+

+#if HAL_USE_USB || defined(__DOXYGEN__)

+

+#include "stm32_usb.h"

+

+/*===========================================================================*/

+/* Driver constants.                                                         */

+/*===========================================================================*/

+

+/**

+ * @brief   Maximum endpoint address.

+ */

+#define USB_MAX_ENDPOINTS                   4

+

+/**

+ * @brief   This device requires the address change after the status packet.

+ */

+#define USB_SET_ADDRESS_MODE                USB_LATE_SET_ADDRESS

+

+/*===========================================================================*/

+/* Driver pre-compile time settings.                                         */

+/*===========================================================================*/

+

+

+/*===========================================================================*/

+/* Derived constants and error checks.                                       */

+/*===========================================================================*/

+

+/*===========================================================================*/

+/* Driver data structures and types.                                         */

+/*===========================================================================*/

+

+/**

+ * @brief   Type of an IN endpoint state structure.

+ */

+typedef struct {

+

+} USBInEndpointState;

+

+/**

+ * @brief   Type of an OUT endpoint state structure.

+ */

+typedef struct {

+

+} USBOutEndpointState;

+

+/**

+ * @brief   Type of an USB endpoint configuration structure.

+ * @note    Platform specific restrictions may apply to endpoints.

+ */

+typedef struct {

+  /**

+   * @brief   Type and mode of the endpoint.

+   */

+  uint32_t                      ep_mode;

+  /**

+   * @brief   IN endpoint notification callback.

+   * @details This field must be set to @p NULL if the IN endpoint is not

+   *          used.

+   */

+  usbepcallback_t               in_cb;

+  /**

+   * @brief   OUT endpoint notification callback.

+   * @details This field must be set to @p NULL if the OUT endpoint is not

+   *          used.

+   */

+  usbepcallback_t               out_cb;

+  /**

+   * @brief   IN endpoint maximum packet size.

+   * @details This field must be set to zero if the IN endpoint is not

+   *          used.

+   */

+  uint16_t                      in_maxsize;

+  /**

+   * @brief   OUT endpoint maximum packet size.

+   * @details This field must be set to zero if the OUT endpoint is not

+   *          used.

+   */

+  uint16_t                      out_maxsize;

+  /**

+   * @brief   @p USBEndpointState associated to the IN endpoint.

+   * @details This structure maintains the state of the IN endpoint when

+   *          the endpoint is not in packet mode. Endpoints configured in

+   *          packet mode must set this field to @p NULL.

+   */

+  USBInEndpointState            *in_state;

+  /**

+   * @brief   @p USBEndpointState associated to the OUT endpoint.

+   * @details This structure maintains the state of the OUT endpoint when

+   *          the endpoint is not in packet mode. Endpoints configured in

+   *          packet mode must set this field to @p NULL.

+   */

+  USBOutEndpointState           *out_state;

+  /* End of the mandatory fields.*/

+} USBEndpointConfig;

+

+/**

+ * @brief   Type of an USB driver configuration structure.

+ */

+typedef struct {

+  /**

+   * @brief   USB events callback.

+   * @details This callback is invoked when an USB driver event is registered.

+   */

+  usbeventcb_t                  event_cb;

+  /**

+   * @brief   Device GET_DESCRIPTOR request callback.

+   * @note    This callback is mandatory and cannot be set to @p NULL.

+   */

+  usbgetdescriptor_t            get_descriptor_cb;

+  /**

+   * @brief   Requests hook callback.

+   * @details This hook allows to be notified of standard requests or to

+   *          handle non standard requests.

+   */

+  usbreqhandler_t               requests_hook_cb;

+  /**

+   * @brief   Start Of Frame callback.

+   */

+  usbcallback_t                 sof_cb;

+  /* End of the mandatory fields.*/

+} USBConfig;

+

+/**

+ * @brief   Structure representing an USB driver.

+ */

+struct USBDriver {

+  /**

+   * @brief   Driver state.

+   */

+  usbstate_t                    state;

+  /**

+   * @brief   Current configuration data.

+   */

+  const USBConfig               *config;

+  /**

+   * @brief   Field available to user, it can be used to associate an

+   *          application-defined handler to the USB driver.

+   */

+  void                          *param;

+  /**

+   * @brief   Bit map of the transmitting IN endpoints.

+   */

+  uint16_t                      transmitting;

+  /**

+   * @brief   Bit map of the receiving OUT endpoints.

+   */

+  uint16_t                      receiving;

+  /**

+   * @brief   Active endpoints configurations.

+   */

+  const USBEndpointConfig       *epc[USB_MAX_ENDPOINTS + 1];

+  /**

+   * @brief   Endpoint 0 state.

+   */

+  usbep0state_t                 ep0state;

+  /**

+   * @brief   Next position in the buffer to be transferred through endpoint 0.

+   */

+  uint8_t                       *ep0next;

+  /**

+   * @brief   Number of bytes yet to be transferred through endpoint 0.

+   */

+  size_t                        ep0n;

+  /**

+   * @brief   Endpoint 0 end transaction callback.

+   */

+  usbcallback_t                 ep0endcb;

+  /**

+   * @brief   Setup packet buffer.

+   */

+  uint8_t                       setup[8];

+  /**

+   * @brief   Current USB device status.

+   */

+  uint16_t                      status;

+  /**

+   * @brief   Assigned USB address.

+   */

+  uint8_t                       address;

+  /**

+   * @brief   Current USB device configuration.

+   */

+  uint8_t                       configuration;

+  /* End of the mandatory fields.*/

+};

+

+/*===========================================================================*/

+/* Driver macros.                                                            */

+/*===========================================================================*/

+

+/**

+ * @brief   Fetches a 16 bits word value from an USB message.

+ *

+ * @param[in] p         pointer to the 16 bits word

+ *

+ * @notapi

+ */

+#define usb_lld_fetch_word(p) (*(uint16_t *)(p))

+

+/**

+ * @brief   Returns the current frame number.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @return              The current frame number.

+ *

+ * @notapi

+ */

+#define usb_lld_get_frame_number(usbp)

+

+/**

+ * @brief   Returns the exact size of a receive transaction.

+ * @details The received size can be different from the size specified in

+ *          @p usbStartReceiveI() because the last packet could have a size

+ *          different from the expected one.

+ * @pre     The OUT endpoint must have been configured in transaction mode

+ *          in order to use this function.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ * @return              Received data size.

+ *

+ * @notapi

+ */

+#define usb_lld_get_transaction_size(usbp, ep)

+

+/**

+ * @brief   Returns the exact size of a received packet.

+ * @pre     The OUT endpoint must have been configured in packet mode

+ *          in order to use this function.

+ *

+ * @param[in] usbp      pointer to the @p USBDriver object

+ * @param[in] ep        endpoint number

+ * @return              Received data size.

+ *

+ * @notapi

+ */

+#define  usb_lld_get_packet_size(usbp, ep)

+

+/*===========================================================================*/

+/* External declarations.                                                    */

+/*===========================================================================*/

+

+#ifdef __cplusplus

+extern "C" {

+#endif

+  void usb_lld_init(void);

+  void usb_lld_start(USBDriver *usbp);

+  void usb_lld_stop(USBDriver *usbp);

+  void usb_lld_reset(USBDriver *usbp);

+  void usb_lld_set_address(USBDriver *usbp);

+  void usb_lld_init_endpoint(USBDriver *usbp, usbep_t ep);

+  void usb_lld_disable_endpoints(USBDriver *usbp);

+  usbepstatus_t usb_lld_get_status_in(USBDriver *usbp, usbep_t ep);

+  usbepstatus_t usb_lld_get_status_out(USBDriver *usbp, usbep_t ep);

+  size_t usb_lld_read_packet(USBDriver *usbp, usbep_t ep,

+                             uint8_t *buf, size_t n);

+  void usb_lld_write_packet(USBDriver *usbp, usbep_t ep,

+                            const uint8_t *buf, size_t n);

+  void usb_lld_start_out(USBDriver *usbp, usbep_t ep,

+                         uint8_t *buf, size_t n);

+  void usb_lld_start_in(USBDriver *usbp, usbep_t ep,

+                        const uint8_t *buf, size_t n);

+  void usb_lld_stall_in(USBDriver *usbp, usbep_t ep);

+  void usb_lld_stall_out(USBDriver *usbp, usbep_t ep);

+  void usb_lld_clear_out(USBDriver *usbp, usbep_t ep);

+  void usb_lld_clear_in(USBDriver *usbp, usbep_t ep);

+#ifdef __cplusplus

+}

+#endif

+

+#endif /* HAL_USE_USB */

+

+#endif /* _USB_LLD_H_ */

+

+/** @} */