diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2013-05-04 20:54:32 +0000 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2013-05-04 20:54:32 +0000 |
| commit | 7464e40a4ba3470c12001069bbe5f31db209dc4d (patch) | |
| tree | 875b1e85378cdd4013e6e48c48148123380b4765 /LUFA/Drivers/USB/Core/UC3 | |
| parent | fd5e98d380820c01e1f4346cf7f11e573e1c5c75 (diff) | |
| download | lufa-7464e40a4ba3470c12001069bbe5f31db209dc4d.tar.gz lufa-7464e40a4ba3470c12001069bbe5f31db209dc4d.tar.bz2 lufa-7464e40a4ba3470c12001069bbe5f31db209dc4d.zip | |
Minor documentation improvements.
Diffstat (limited to 'LUFA/Drivers/USB/Core/UC3')
| -rw-r--r-- | LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h | 9 | ||||
| -rw-r--r-- | LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h | 8 |
2 files changed, 8 insertions, 9 deletions
diff --git a/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h b/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h index bcf6b64a5..7e582adef 100644 --- a/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h @@ -167,9 +167,8 @@ }; /* Inline Functions: */ - /** Configures the specified endpoint address with the given endpoint type, direction, bank size - * and banking mode. Once configured, the endpoint may be read from or written to, depending - * on its direction. + /** Configures the specified endpoint address with the given endpoint type, bank size and number of hardware + * banks. Once configured, the endpoint may be read from or written to, depending on its direction. * * \param[in] Address Endpoint address to configure. * @@ -209,7 +208,7 @@ const uint8_t Banks) { uint8_t Number = (Address & ENDPOINT_EPNUM_MASK); - + if (Number >= ENDPOINT_TOTAL_ENDPOINTS) return false; @@ -277,7 +276,7 @@ static inline void Endpoint_ResetEndpoint(const uint8_t Address) { uint32_t EndpointNumber = (Address & ENDPOINT_EPNUM_MASK); - + AVR32_USBB.uerst |= (AVR32_USBB_EPRST0_MASK << EndpointNumber); AVR32_USBB.uerst &= ~(AVR32_USBB_EPRST0_MASK << EndpointNumber); USB_Endpoint_FIFOPos[EndpointNumber] = &AVR32_USBB_SLAVE[EndpointNumber * ENDPOINT_HSB_ADDRESS_SPACE_SIZE]; diff --git a/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h b/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h index f09d56096..a8cb29ebf 100644 --- a/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h @@ -206,7 +206,7 @@ { return (((&AVR32_USBB.UPCFG0)[USB_Pipe_SelectedPipe].ptoken == PIPE_TOKEN_OUT) ? PIPE_DIR_OUT : PIPE_DIR_IN); } - + /** Returns the pipe address of the currently selected pipe. This is typically used to save the * currently selected pipe number so that it can be restored after another pipe has been manipulated. * @@ -817,12 +817,12 @@ * \param[in] Entries Number of entries in the pipe table to configure. * * \return Boolean \c true if all pipes configured successfully, \c false otherwise. - */ + */ bool Pipe_ConfigurePipeTable(const USB_Pipe_Table_t* const Table, const uint8_t Entries); - /** Configures the specified pipe address with the given pipe type, endpoint address within the attached device, bank size - * and number of hardware banks. + /** Configures the specified pipe address with the given pipe type, endpoint address within the attached device, + * bank size and number of hardware banks. * * A newly configured pipe is frozen by default, and must be unfrozen before use via the \ref Pipe_Unfreeze() * before being used. Pipes should be kept frozen unless waiting for data from a device while in IN mode, or |