Commit 7dffa15c authored by Dean Camera's avatar Dean Camera
Browse files

Massive corrections to the project documentation and code comments, thanks to...

Massive corrections to the project documentation and code comments, thanks to Russian translation services provided by Andrey from Microsin.ru.
parent 0210fa56
...@@ -185,7 +185,7 @@ ...@@ -185,7 +185,7 @@
*/ */
uint8_t CDC_Host_SendControlLineStateChange(USB_ClassInfo_CDC_Host_t* const CDCInterfaceInfo) ATTR_NON_NULL_PTR_ARG(1); 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. * to the receiving device.
* *
* \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state. * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state.
......
...@@ -100,7 +100,7 @@ ...@@ -100,7 +100,7 @@
* after \ref SI_Host_ConfigurePipes() is called and the Host state machine is in the * after \ref SI_Host_ConfigurePipes() is called and the Host state machine is in the
* Configured state. * 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 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. */ uint16_t DataOUTPipeSize; /**< Size in bytes of the Still Image interface's OUT data pipe. */
...@@ -188,7 +188,7 @@ ...@@ -188,7 +188,7 @@
PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1) PIMA_Container_t* const PIMAHeader) ATTR_NON_NULL_PTR_ARG(1)
ATTR_NON_NULL_PTR_ARG(2); 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. * 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 * \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 @@ ...@@ -221,7 +221,7 @@
const uint8_t TotalParams, const uint8_t TotalParams,
uint32_t* const Params) ATTR_NON_NULL_PTR_ARG(1); 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. * 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 * \pre This function must only be called when the Host state machine is in the \ref HOST_STATE_Configured state or the
......
...@@ -452,7 +452,7 @@ ...@@ -452,7 +452,7 @@
uint16_t Length, uint16_t Length,
uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); 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[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. * \param[in] Length Number of bytes to send via the currently selected endpoint.
...@@ -465,7 +465,7 @@ ...@@ -465,7 +465,7 @@
uint16_t Length, uint16_t Length,
uint16_t* const BytesProcessed) ATTR_NON_NULL_PTR_ARG(1); 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[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. * \param[in] Length Number of bytes to send via the currently selected endpoint.
......
...@@ -625,7 +625,7 @@ ...@@ -625,7 +625,7 @@
return UEDATX; 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 * \ingroup Group_EndpointPrimitiveRW_AVR8
* *
......
...@@ -133,7 +133,7 @@ ...@@ -133,7 +133,7 @@
OTGCON &= ~(1 << HNPREQ); 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. * \return Boolean \c true if a HNP is currently being issued by the connected device, \c false otherwise.
*/ */
......
...@@ -590,7 +590,7 @@ ...@@ -590,7 +590,7 @@
return UPDATX; 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 * \ingroup Group_PipePrimitiveRW_AVR8
* *
......
...@@ -78,7 +78,7 @@ ...@@ -78,7 +78,7 @@
/** Event for USB mode pin level change. This event fires when the USB interface is set to dual role /** 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 * 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 * 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. * \note This event only exists on microcontrollers that support dual role USB modes.
* \n\n * \n\n
......
...@@ -222,7 +222,7 @@ ...@@ -222,7 +222,7 @@
{ {
FEATURE_SEL_EndpointHalt = 0x00, /**< Feature selector for Clear Feature or Set Feature commands. When 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 * 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. * its stall condition changed.
*/ */
FEATURE_SEL_DeviceRemoteWakeup = 0x01, /**< Feature selector for Device level Remote Wakeup enable set or clear. FEATURE_SEL_DeviceRemoteWakeup = 0x01, /**< Feature selector for Device level Remote Wakeup enable set or clear.
......
...@@ -633,7 +633,7 @@ ...@@ -633,7 +633,7 @@
return *(USB_EndpointFIFOPos[USB_SelectedEndpoint]++); 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 * \ingroup Group_EndpointPrimitiveRW_UC3
* *
......
...@@ -614,7 +614,7 @@ ...@@ -614,7 +614,7 @@
return *(USB_PipeFIFOPos[USB_SelectedPipe]++); 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 * \ingroup Group_PipePrimitiveRW_UC3
* *
......
...@@ -176,7 +176,7 @@ ...@@ -176,7 +176,7 @@
* *
* To initialize the Class driver instance, the driver's <tt><i>{Class Name}</i>_Device_ConfigureEndpoints()</tt> function * 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 * 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 * 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: * the same class type can be initialized like this:
* *
......
...@@ -33,7 +33,7 @@ ...@@ -33,7 +33,7 @@
* *
* <b>Fixed:</b> * <b>Fixed:</b>
* - Core: * - Core:
* - <i>None</i> * - Large number of documentation and code comment corrections (thanks to Andrewy from Microsin.ru)
* - Library Applications: * - Library Applications:
* - Fixed incorrect signature in the CDC and DFU class bootloaders for the ATMEGA8U2 * - Fixed incorrect signature in the CDC and DFU class bootloaders for the ATMEGA8U2
* - Fixed KeyboardHost and KeyboardHostWithParser demos displaying incorrect values when numerical keys were pressed * - Fixed KeyboardHost and KeyboardHostWithParser demos displaying incorrect values when numerical keys were pressed
......
...@@ -112,7 +112,7 @@ ...@@ -112,7 +112,7 @@
* located in the parent Board directory should be included instead. * located in the parent Board directory should be included instead.
* *
* \dir LUFA/Drivers/Board/AVR8/EVK527 * \dir LUFA/Drivers/Board/AVR8/EVK527
* \brief XPLAIN board hardware driver files. * \brief EVK527 board hardware driver files.
* *
* This folder contains drivers for hardware on the Atmel EVK527 development board. The header files in this folder should * This folder contains drivers for hardware on the Atmel EVK527 development board. The header files in this folder should
* not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory * not be included directly in user applications; the similarly named dispatch header files located in the parent Board directory
...@@ -188,6 +188,13 @@ ...@@ -188,6 +188,13 @@
* files in this folder should not be included directly in user applications; the similarly named dispatch header files located * files in this folder should not be included directly in user applications; the similarly named dispatch header files located
* in the parent Board directory should be included instead. * in the parent Board directory should be included instead.
* *
* \dir LUFA/Drivers/Board/AVR8/TUL
* \brief TUL board hardware driver files.
*
* This folder contains drivers for hardware on the Busware TUL (http://busware.de/tiki-index.php?page=TUL).
* The header files in this folder should not be included directly in user applications; the similarly named dispatch header files
* located in the parent Board directory should be included instead.
*
* \dir LUFA/Drivers/Board/AVR8/UDIP * \dir LUFA/Drivers/Board/AVR8/UDIP
* \brief UDIP board hardware driver files. * \brief UDIP board hardware driver files.
* *
......
...@@ -7,6 +7,9 @@ ...@@ -7,6 +7,9 @@
/** /**
* \page Page_Resources Library Resources * \page Page_Resources Library Resources
* *
* \section Sec_UnofficialResources Unofficial Resources
* Unofficial Russian LUFA documentation translation: http://microsin.ru/Download.cnt/doc/LUFA/ \n
*
* \section Sec_ProjectPages LUFA Related Webpages * \section Sec_ProjectPages LUFA Related Webpages
* Project Homepage: http://www.lufa-lib.org \n * Project Homepage: http://www.lufa-lib.org \n
* Commercial Licenses: http://www.lufa-lib.org/license \n * Commercial Licenses: http://www.lufa-lib.org/license \n
......
...@@ -154,7 +154,7 @@ ...@@ -154,7 +154,7 @@
* *
* <b>Host Mode</b> * <b>Host Mode</b>
* - The \ref CDC_Host_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was * - The \ref CDC_Host_ReceiveByte() function has changed, and now returns a signed 16-bit integer, with -1 indicating no data was
* received. This allows for more efficient coding, as a call to \ref CDC_Device_BytesReceived() is no longer needed if the exact * received. This allows for more efficient coding, as a call to \ref CDC_Host_BytesReceived() is no longer needed if the exact
* number of queued bytes received is not needed. * number of queued bytes received is not needed.
* - The \ref CDC_Host_USBTask() now calls \ref CDC_Host_Flush() automatically, flushing any queued data to the attached device. Manual * - The \ref CDC_Host_USBTask() now calls \ref CDC_Host_Flush() automatically, flushing any queued data to the attached device. Manual
* flushing of the interface is no longer needed if the flushes should be in sync with calls to \ref CDC_Host_USBTask(). * flushing of the interface is no longer needed if the flushes should be in sync with calls to \ref CDC_Host_USBTask().
...@@ -339,7 +339,7 @@ ...@@ -339,7 +339,7 @@
* - The HWB driver has changed to the \c Buttons driver. See the board Buttons driver documentation for the new API. * - The HWB driver has changed to the \c Buttons driver. See the board Buttons driver documentation for the new API.
* *
* <b>Dual Role Mode</b> * <b>Dual Role Mode</b>
* - The \c USB_PowerOnFail even has been renamed to \c USB_InitFailure. * - The \c USB_PowerOnFail event has been renamed to \c USB_InitFailure.
* - The functions in \c OTG.h have been renamed to remain more consistent with the library API. See the functions in \c OTG.h for more * - The functions in \c OTG.h have been renamed to remain more consistent with the library API. See the functions in \c OTG.h for more
* details. * details.
* *
......
...@@ -161,7 +161,7 @@ void ISPTarget_EnableTargetISP(void) ...@@ -161,7 +161,7 @@ void ISPTarget_EnableTargetISP(void)
DDRB |= ((1 << 1) | (1 << 2)); DDRB |= ((1 << 1) | (1 << 2));
PORTB |= ((1 << 0) | (1 << 3)); PORTB |= ((1 << 0) | (1 << 3));
ISPTarget_ConfigureSoftwareISP(SCKDuration); ISPTarget_ConfigureSoftwareSPI(SCKDuration);
} }
} }
...@@ -185,7 +185,7 @@ void ISPTarget_DisableTargetISP(void) ...@@ -185,7 +185,7 @@ void ISPTarget_DisableTargetISP(void)
} }
} }
/** Configures the AVR to produce a .5MHz rescue clock out of the OCR1A pin of the AVR, so /** Configures the AVR to produce a 4MHz rescue clock out of the OCR1A pin of the AVR, so
* that it can be fed into the XTAL1 pin of an AVR whose fuses have been mis-configured for * that it can be fed into the XTAL1 pin of an AVR whose fuses have been mis-configured for
* an external clock rather than a crystal. When used, the ISP speed must be 125KHz for this * an external clock rather than a crystal. When used, the ISP speed must be 125KHz for this
* functionality to work correctly. * functionality to work correctly.
...@@ -217,14 +217,14 @@ void ISPTarget_ConfigureRescueClock(void) ...@@ -217,14 +217,14 @@ void ISPTarget_ConfigureRescueClock(void)
#endif #endif
} }
/** Configures the AVR's timer ready to produce software ISP for the slower ISP speeds that /** Configures the AVR's timer ready to produce software SPI for the slower ISP speeds that
* cannot be obtained when using the AVR's hardware SPI module. * cannot be obtained when using the AVR's hardware SPI module.
* *
* \param[in] SCKDuration Duration of the desired software ISP SCK clock * \param[in] SCKDuration Duration of the desired software ISP SCK clock
*/ */
void ISPTarget_ConfigureSoftwareISP(const uint8_t SCKDuration) void ISPTarget_ConfigureSoftwareSPI(const uint8_t SCKDuration)
{ {
/* Configure Timer 1 for software ISP using the specified SCK duration */ /* Configure Timer 1 for software SPI using the specified SCK duration */
TIMSK1 = (1 << OCIE1A); TIMSK1 = (1 << OCIE1A);
TCNT1 = 0; TCNT1 = 0;
OCR1A = pgm_read_word(&TimerCompareFromSCKDuration[SCKDuration - sizeof(SPIMaskFromSCKDuration)]); OCR1A = pgm_read_word(&TimerCompareFromSCKDuration[SCKDuration - sizeof(SPIMaskFromSCKDuration)]);
......
...@@ -72,7 +72,7 @@ ...@@ -72,7 +72,7 @@
void ISPTarget_EnableTargetISP(void); void ISPTarget_EnableTargetISP(void);
void ISPTarget_DisableTargetISP(void); void ISPTarget_DisableTargetISP(void);
void ISPTarget_ConfigureRescueClock(void); void ISPTarget_ConfigureRescueClock(void);
void ISPTarget_ConfigureSoftwareISP(const uint8_t SCKDuration); void ISPTarget_ConfigureSoftwareSPI(const uint8_t SCKDuration);
uint8_t ISPTarget_TransferSoftSPIByte(const uint8_t Byte); uint8_t ISPTarget_TransferSoftSPIByte(const uint8_t Byte);
void ISPTarget_ChangeTargetResetLine(const bool ResetTarget); void ISPTarget_ChangeTargetResetLine(const bool ResetTarget);
uint8_t ISPTarget_WaitWhileTargetBusy(void); uint8_t ISPTarget_WaitWhileTargetBusy(void);
......
...@@ -206,7 +206,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress, ...@@ -206,7 +206,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
if (WriteLength & 0x01) if (WriteLength & 0x01)
WriteBuffer[WriteLength++] = 0xFF; WriteBuffer[WriteLength++] = 0xFF;
/* Set the NVM control register to the WORD WRITE command for memory reading */ /* Set the NVM control register to the WORD WRITE command for memory writing */
TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr); TINYNVM_SendWriteNVMRegister(XPROG_Param_NVMCMDRegAddr);
XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE); XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE);
...@@ -227,7 +227,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress, ...@@ -227,7 +227,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI); XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
XPROGTarget_SendByte(*(WriteBuffer++)); XPROGTarget_SendByte(*(WriteBuffer++));
/* Need to decrement the write length twice, since we read out a whole word */ /* Need to decrement the write length twice, since we wrote a whole two-byte word */
WriteLength -= 2; WriteLength -= 2;
} }
......
...@@ -140,7 +140,7 @@ void XPROGTarget_SendByte(const uint8_t Byte) ...@@ -140,7 +140,7 @@ void XPROGTarget_SendByte(const uint8_t Byte)
UDR1 = Byte; UDR1 = Byte;
} }
/** Receives a byte via the software USART, blocking until data is received. /** Receives a byte via the hardware USART, blocking until data is received or timeout expired.
* *
* \return Received byte from the USART * \return Received byte from the USART
*/ */
......
...@@ -158,7 +158,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn ...@@ -158,7 +158,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn
return; return;
} }
/* Decrement the blocks remaining counter and reset the sub block counter */ /* Decrement the blocks remaining counter */
TotalBlocks--; TotalBlocks--;
} }
...@@ -372,7 +372,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress, ...@@ -372,7 +372,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
BytesInBlockDiv16++; BytesInBlockDiv16++;
} }
/* Decrement the blocks remaining counter and reset the sub block counter */ /* Decrement the blocks remaining counter */
TotalBlocks--; TotalBlocks--;
} }
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment