diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2011-06-05 13:55:56 +0000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2011-06-05 13:55:56 +0000 |
commit | 7dffa15c1670806cc053b9930f341b53e30f7384 (patch) | |
tree | b06af7dc2e6e2cf9f5bf20cb848cff5ee3f527c8 /LUFA/Drivers/USB | |
parent | 0210fa5648b1ed65caa384f966ac40b4ecc489ae (diff) | |
download | lufa-7dffa15c1670806cc053b9930f341b53e30f7384.tar.gz lufa-7dffa15c1670806cc053b9930f341b53e30f7384.tar.bz2 lufa-7dffa15c1670806cc053b9930f341b53e30f7384.zip |
Massive corrections to the project documentation and code comments, thanks to Russian translation services provided by Andrey from Microsin.ru.
Diffstat (limited to 'LUFA/Drivers/USB')
-rw-r--r-- | LUFA/Drivers/USB/Class/Common/Audio.h | 4 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Common/MassStorage.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Device/Audio.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Device/MIDI.h | 10 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Device/RNDIS.h | 20 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Host/CDC.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Class/Host/StillImage.h | 6 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h | 4 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/AVR8/OTG_AVR8.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/Events.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/StdRequestType.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h | 2 | ||||
-rw-r--r-- | LUFA/Drivers/USB/USB.h | 2 |
16 files changed, 33 insertions, 33 deletions
diff --git a/LUFA/Drivers/USB/Class/Common/Audio.h b/LUFA/Drivers/USB/Class/Common/Audio.h index fd9a3a92b..247f7f6d4 100644 --- a/LUFA/Drivers/USB/Class/Common/Audio.h +++ b/LUFA/Drivers/USB/Class/Common/Audio.h @@ -477,7 +477,7 @@ uint8_t UnitID; /**< ID value of this feature unit - must be a unique value within the device. */ uint8_t SourceID; /**< Source ID value of the audio source input into this feature unit. */ - uint8_t ControlSize; /**< Size of each element in the \c ChanelControlls array. */ + uint8_t ControlSize; /**< Size of each element in the \c ChannelControls array. */ uint8_t ChannelControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */ uint8_t FeatureUnitStrIndex; /**< Index of a string descriptor describing this descriptor within the device. */ @@ -506,7 +506,7 @@ uint8_t bUnitID; /**< ID value of this feature unit - must be a unique value within the device. */ uint8_t bSourceID; /**< Source ID value of the audio source input into this feature unit. */ - uint8_t bControlSize; /**< Size of each element in the \c ChanelControlls array. */ + uint8_t bControlSize; /**< Size of each element in the \c ChannelControls array. */ uint8_t bmaControls[3]; /**< Feature masks for the control channel, and each separate audio channel. */ uint8_t iFeature; /**< Index of a string descriptor describing this descriptor within the device. */ diff --git a/LUFA/Drivers/USB/Class/Common/MassStorage.h b/LUFA/Drivers/USB/Class/Common/MassStorage.h index 0f5db97ec..9f8de4e0b 100644 --- a/LUFA/Drivers/USB/Class/Common/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Common/MassStorage.h @@ -132,7 +132,7 @@ /** SCSI Sense Code to indicate an error whilst accessing the medium. */ #define SCSI_SENSE_KEY_MEDIUM_ERROR 0x03 - /** SCSI Sense Code to indicate a hardware has occurred. */ + /** SCSI Sense Code to indicate a hardware error has occurred. */ #define SCSI_SENSE_KEY_HARDWARE_ERROR 0x04 /** SCSI Sense Code to indicate that an illegal request has been issued. */ diff --git a/LUFA/Drivers/USB/Class/Device/Audio.h b/LUFA/Drivers/USB/Class/Device/Audio.h index a09076341..ed23683a6 100644 --- a/LUFA/Drivers/USB/Class/Device/Audio.h +++ b/LUFA/Drivers/USB/Class/Device/Audio.h @@ -218,7 +218,7 @@ /** Reads the next 8-bit audio sample from the current audio interface. * * \pre This should be preceded immediately by a call to the \ref Audio_Device_IsSampleReceived() function to ensure - * ensure the correct endpoint is selected and ready for data. + * that the correct endpoint is selected and ready for data. * * \param[in,out] AudioInterfaceInfo Pointer to a structure containing an Audio Class configuration and state. * diff --git a/LUFA/Drivers/USB/Class/Device/MIDI.h b/LUFA/Drivers/USB/Class/Device/MIDI.h index c3a97f6ef..e0fa50259 100644 --- a/LUFA/Drivers/USB/Class/Device/MIDI.h +++ b/LUFA/Drivers/USB/Class/Device/MIDI.h @@ -81,13 +81,13 @@ { uint8_t StreamingInterfaceNumber; /**< Index of the Audio Streaming interface within the device this structure controls. */ - uint8_t DataINEndpointNumber; /**< Endpoint number of the incoming MIDI data, if available (zero if unused). */ - uint16_t DataINEndpointSize; /**< Size in bytes of the incoming MIDI data endpoint, if available (zero if unused). */ + uint8_t DataINEndpointNumber; /**< Endpoint number of the incoming MIDI IN data, if available (zero if unused). */ + uint16_t DataINEndpointSize; /**< Size in bytes of the incoming MIDI IN data endpoint, if available (zero if unused). */ bool DataINEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */ - uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI data, if available (zero if unused). */ - uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI data endpoint, if available (zero if unused). */ - bool DataOUTEndpointDoubleBank; /**< Indicates if the MIDI interface's IN data endpoint should use double banking. */ + uint8_t DataOUTEndpointNumber; /**< Endpoint number of the outgoing MIDI OUT data, if available (zero if unused). */ + uint16_t DataOUTEndpointSize; /**< Size in bytes of the outgoing MIDI OUT data endpoint, if available (zero if unused). */ + bool DataOUTEndpointDoubleBank; /**< Indicates if the MIDI interface's OUT data endpoint should use double banking. */ } Config; /**< Config data for the USB class interface within the device. All elements in this section * <b>must</b> be set or the interface will fail to enumerate and operate correctly. */ diff --git a/LUFA/Drivers/USB/Class/Device/RNDIS.h b/LUFA/Drivers/USB/Class/Device/RNDIS.h index 734ceb3fd..66b85b15e 100644 --- a/LUFA/Drivers/USB/Class/Device/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Device/RNDIS.h @@ -79,23 +79,23 @@ { const struct { - uint8_t ControlInterfaceNumber; /**< Interface number of the CDC control interface within the device. */ + uint8_t ControlInterfaceNumber; /**< Interface number of the RNDIS control interface within the device. */ - uint8_t DataINEndpointNumber; /**< Endpoint number of the CDC interface's IN data endpoint. */ - uint16_t DataINEndpointSize; /**< Size in bytes of the CDC interface's IN data endpoint. */ + uint8_t DataINEndpointNumber; /**< Endpoint number of the RNDIS interface's IN data endpoint. */ + uint16_t DataINEndpointSize; /**< Size in bytes of the RNDIS interface's IN data endpoint. */ bool DataINEndpointDoubleBank; /**< Indicates if the RNDIS interface's IN data endpoint should use double banking. */ - uint8_t DataOUTEndpointNumber; /**< Endpoint number of the CDC interface's OUT data endpoint. */ - uint16_t DataOUTEndpointSize; /**< Size in bytes of the CDC interface's OUT data endpoint. */ + uint8_t DataOUTEndpointNumber; /**< Endpoint number of the RNDIS interface's OUT data endpoint. */ + uint16_t DataOUTEndpointSize; /**< Size in bytes of the RNDIS interface's OUT data endpoint. */ bool DataOUTEndpointDoubleBank; /**< Indicates if the RNDIS interface's OUT data endpoint should use double banking. */ - uint8_t NotificationEndpointNumber; /**< Endpoint number of the CDC interface's IN notification endpoint, if used. */ - uint16_t NotificationEndpointSize; /**< Size in bytes of the CDC interface's IN notification endpoint, if used. */ + uint8_t NotificationEndpointNumber; /**< Endpoint number of the RNDIS interface's IN notification endpoint, if used. */ + uint16_t NotificationEndpointSize; /**< Size in bytes of the RNDIS interface's IN notification endpoint, if used. */ bool NotificationEndpointDoubleBank; /**< Indicates if the RNDIS interface's notification endpoint should use double banking. */ char* AdapterVendorDescription; /**< String description of the adapter vendor. */ MAC_Address_t AdapterMACAddress; /**< MAC address of the adapter. */ - } Config; /**< Config data for the USB class interface within the device. All elements in this section. + } Config; /**< Config data for the USB class interface within the device. All elements in this section * <b>must</b> be set or the interface will fail to enumerate and operate correctly. */ struct @@ -114,7 +114,7 @@ /* Function Prototypes: */ /** Configures the endpoints of a given RNDIS interface, ready for use. This should be linked to the library * \ref EVENT_USB_Device_ConfigurationChanged() event so that the endpoints are configured when the configuration - * containing the given HID interface is selected. + * containing the given RNDIS interface is selected. * * \note The endpoint index numbers as given in the interface's configuration structure must not overlap with any other * interface, or endpoint bank corruption will occur. Gaps in the allocated endpoint numbers or non-sequential indexes @@ -133,7 +133,7 @@ */ void RNDIS_Device_ProcessControlRequest(USB_ClassInfo_RNDIS_Device_t* const RNDISInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); - /** General management task for a given HID class interface, required for the correct operation of the interface. This should + /** General management task for a given RNDIS class interface, required for the correct operation of the interface. This should * be called frequently in the main program loop, before the master USB management task \ref USB_USBTask(). * * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing a RNDIS Class configuration and state. diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index 4bb98630f..455e2f9ef 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -185,7 +185,7 @@ */ uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); - /** Sends a Send Break request to the device. This is generally used to separate data data or to indicate a special condition + /** Sends a Send Break request to the device. This is generally used to separate data or to indicate a special condition * to the receiving device. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state. diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h index 51dc1e99d..b79b81747 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImage.h +++ b/LUFA/Drivers/USB/Class/Host/StillImage.h @@ -100,7 +100,7 @@ * after \ref SI_Host_ConfigurePipes() is called and the Host state machine is in the * Configured state. */ - uint8_t InterfaceNumber; /**< Interface index of the Mass Storage interface within the attached device. */ + uint8_t InterfaceNumber; /**< Interface index of the Still Image interface within the attached device. */ uint16_t DataINPipeSize; /**< Size in bytes of the Still Image interface's IN data pipe. */ uint16_t DataOUTPipeSize; /**< Size in bytes of the Still Image interface's OUT data pipe. */ @@ -188,7 +188,7 @@ PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1) ATTR_NON_NULL_PTR_ARG(2); - /** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with + /** Receives a raw PIMA block header from the device. This can be used to receive arbitrary PIMA blocks from the device with * or without parameters. * * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the @@ -221,7 +221,7 @@ const uint8_t TotalParams, uint32_t* const Params) ATTR_NON_NULL_PTR_ARG(1); - /** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data + /** Receives and checks a response block from the attached Still Image device, once a command has been issued and all data * associated with the command has been transferred. * * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the diff --git a/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h index 433311d3b..f5a03d194 100644 --- a/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h +++ b/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.h @@ -452,7 +452,7 @@ uint16_t Length,
uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);
- /** EEPROM buffer source version of \ref Endpoint_Read_Stream_LE().
+ /** EEPROM buffer destination version of \ref Endpoint_Read_Stream_LE().
*
* \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.
* \param[in] Length Number of bytes to send via the currently selected endpoint.
@@ -465,7 +465,7 @@ uint16_t Length,
uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1);
- /** EEPROM buffer source version of \ref Endpoint_Read_Stream_BE().
+ /** EEPROM buffer destination version of \ref Endpoint_Read_Stream_BE().
*
* \param[out] Buffer Pointer to the destination data buffer to write to, located in EEPROM memory space.
* \param[in] Length Number of bytes to send via the currently selected endpoint.
diff --git a/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h index bdbe31c33..7868ac36a 100644 --- a/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h +++ b/LUFA/Drivers/USB/Core/AVR8/Endpoint_AVR8.h @@ -625,7 +625,7 @@ return UEDATX; } - /** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints. + /** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints. * * \ingroup Group_EndpointPrimitiveRW_AVR8 * diff --git a/LUFA/Drivers/USB/Core/AVR8/OTG_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/OTG_AVR8.h index fda145c1e..e9b92c047 100644 --- a/LUFA/Drivers/USB/Core/AVR8/OTG_AVR8.h +++ b/LUFA/Drivers/USB/Core/AVR8/OTG_AVR8.h @@ -133,7 +133,7 @@ OTGCON &= ~(1 << HNPREQ); } - /** Indicates if the connected device is not currently sending a HNP request. + /** Indicates if the connected device is currently sending a HNP request. * * \return Boolean \c true if a HNP is currently being issued by the connected device, \c false otherwise. */ diff --git a/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h b/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h index c7e21f73a..c6bdcfb4a 100644 --- a/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h +++ b/LUFA/Drivers/USB/Core/AVR8/Pipe_AVR8.h @@ -590,7 +590,7 @@ return UPDATX; } - /** Writes one byte from the currently selected pipe's bank, for IN direction pipes. + /** Writes one byte to the currently selected pipe's bank, for IN direction pipes. * * \ingroup Group_PipePrimitiveRW_AVR8 * diff --git a/LUFA/Drivers/USB/Core/Events.h b/LUFA/Drivers/USB/Core/Events.h index 18814715e..2ea14bf10 100644 --- a/LUFA/Drivers/USB/Core/Events.h +++ b/LUFA/Drivers/USB/Core/Events.h @@ -78,7 +78,7 @@ /** Event for USB mode pin level change. This event fires when the USB interface is set to dual role * mode, and the UID pin level has changed to indicate a new mode (device or host). This event fires * before the mode is switched to the newly indicated mode but after the \ref EVENT_USB_Device_Disconnect - * event has fired (if connected before the role change). + * event has fired (if disconnected before the role change). * * \note This event only exists on microcontrollers that support dual role USB modes. * \n\n diff --git a/LUFA/Drivers/USB/Core/StdRequestType.h b/LUFA/Drivers/USB/Core/StdRequestType.h index 83f59afc6..9a9e6f214 100644 --- a/LUFA/Drivers/USB/Core/StdRequestType.h +++ b/LUFA/Drivers/USB/Core/StdRequestType.h @@ -222,7 +222,7 @@ { FEATURE_SEL_EndpointHalt = 0x00, /**< Feature selector for Clear Feature or Set Feature commands. When * used in a Set Feature or Clear Feature request this indicates that an - * endpoint (whose address is given elsewhere in the request should have + * endpoint (whose address is given elsewhere in the request) should have * its stall condition changed. */ FEATURE_SEL_DeviceRemoteWakeup = 0x01, /**< Feature selector for Device level Remote Wakeup enable set or clear. diff --git a/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h b/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h index 1c9f6ccf1..41ab16564 100644 --- a/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Endpoint_UC3.h @@ -633,7 +633,7 @@ return *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++);
}
- /** Writes one byte from the currently selected endpoint's bank, for IN direction endpoints.
+ /** Writes one byte to the currently selected endpoint's bank, for IN direction endpoints.
*
* \ingroup Group_EndpointPrimitiveRW_UC3
*
diff --git a/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h b/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h index b6f015c11..c10518548 100644 --- a/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h +++ b/LUFA/Drivers/USB/Core/UC3/Pipe_UC3.h @@ -614,7 +614,7 @@ return *(USB_PipeFIFOPos[USB_SelectedPipe]++);
}
- /** Writes one byte from the currently selected pipe's bank, for IN direction pipes.
+ /** Writes one byte to the currently selected pipe's bank, for IN direction pipes.
*
* \ingroup Group_PipePrimitiveRW_UC3
*
diff --git a/LUFA/Drivers/USB/USB.h b/LUFA/Drivers/USB/USB.h index 9c72e3856..958eeea35 100644 --- a/LUFA/Drivers/USB/USB.h +++ b/LUFA/Drivers/USB/USB.h @@ -176,7 +176,7 @@ * * To initialize the Class driver instance, the driver's <tt><i>{Class Name}</i>_Device_ConfigureEndpoints()</tt> function * should be called in response to the \ref EVENT_USB_Device_ConfigurationChanged() event. This function will return a - * boolean value if the driver successfully initialized the instance. Like all the class driver functions, this function + * boolean true value if the driver successfully initialized the instance. Like all the class driver functions, this function * takes in the address of the specific instance you wish to initialize - in this manner, multiple separate instances of * the same class type can be initialized like this: * |