Massive corrections to the project documentation and code comments, thanks to Russian translation services provided by Andrey from Microsin.ru.

This commit is contained in:
Dean Camera 2011-06-05 13:55:56 +00:00
parent 0210fa5648
commit 7dffa15c16
93 changed files with 1750 additions and 153 deletions

View file

@ -161,7 +161,7 @@ void ISPTarget_EnableTargetISP(void)
DDRB |= ((1 << 1) | (1 << 2));
PORTB |= ((1 << 0) | (1 << 3));
ISPTarget_ConfigureSoftwareISP(SCKDuration);
ISPTarget_ConfigureSoftwareSPI(SCKDuration);
}
}
@ -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
* an external clock rather than a crystal. When used, the ISP speed must be 125KHz for this
* functionality to work correctly.
@ -217,14 +217,14 @@ void ISPTarget_ConfigureRescueClock(void)
#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.
*
* \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);
TCNT1 = 0;
OCR1A = pgm_read_word(&TimerCompareFromSCKDuration[SCKDuration - sizeof(SPIMaskFromSCKDuration)]);

View file

@ -72,7 +72,7 @@
void ISPTarget_EnableTargetISP(void);
void ISPTarget_DisableTargetISP(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);
void ISPTarget_ChangeTargetResetLine(const bool ResetTarget);
uint8_t ISPTarget_WaitWhileTargetBusy(void);

View file

@ -206,7 +206,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
if (WriteLength & 0x01)
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);
XPROGTarget_SendByte(TINY_NVM_CMD_WORDWRITE);
@ -227,7 +227,7 @@ bool TINYNVM_WriteMemory(const uint16_t WriteAddress,
XPROGTarget_SendByte(TPI_CMD_SST | TPI_POINTER_INDIRECT_PI);
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;
}

View file

@ -140,7 +140,7 @@ void XPROGTarget_SendByte(const uint8_t 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
*/

View file

@ -158,7 +158,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn
return;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}
@ -372,7 +372,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
BytesInBlockDiv16++;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}

File diff suppressed because it is too large Load diff

View file

@ -87,7 +87,7 @@
/** Retrieves a bit from the next location inside a given bit buffer.
*
* \param[in,out] Buffer Bit buffer to store a bit into
* \param[in,out] Buffer Bit buffer to retrieve a bit from
*
* \return Next bit from the buffer
*/

View file

@ -87,13 +87,11 @@
* </tr>
* </table>
*
* This project is based on the LUFA Keyboard projectnstration application,
* written by Denver Gingerich.
* This project is based on the LUFA Keyboard project demonstration application, written by Denver Gingerich.
*
* This application uses a keyboard HID driver to communicate the data collected
* a TTL magnetic stripe reader to the connected computer. The raw bitstream
* obtained from the magnetic stripe reader is "typed" through the keyboard
* driver as 0's and 1's. After every card swipe, the project will send a return key.
* This application uses a keyboard HID driver to communicate the data collected a TTL magnetic stripe reader
* to the connected computer. The raw bitstream obtained from the magnetic stripe reader is "typed" through
* the keyboard driver as 0's and 1's. After every card swipe, the project will send a return key.
*
* \section Sec_Options Project Options
*

View file

@ -164,7 +164,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

View file

@ -157,7 +157,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn
return;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}
@ -371,7 +371,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
BytesInBlockDiv16++;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}

View file

@ -294,7 +294,7 @@ bool CALLBACK_HID_Device_CreateHIDReport(USB_ClassInfo_HID_Device_t* const HIDIn
* \param[in] HIDInterfaceInfo Pointer to the HID class interface configuration structure being referenced
* \param[in] ReportID Report ID of the received report from the host
* \param[in] ReportType The type of report that the host has sent, either HID_REPORT_ITEM_Out or HID_REPORT_ITEM_Feature
* \param[in] ReportData Pointer to a buffer where the created report has been stored
* \param[in] ReportData Pointer to a buffer where the received report has been stored
* \param[in] ReportSize Size in bytes of the received HID report
*/
void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDInterfaceInfo,

View file

@ -154,6 +154,7 @@ void DHCPServerApp_Callback(void)
* \param[out] DHCPHeader Location in the packet buffer where the BOOTP header should be written to
* \param[in] DHCPMessageType DHCP Message type, such as DHCP_DISCOVER
* \param[in] ClientHardwareAddress Client MAC address the created transaction should be directed to
* \param[in] PreferredClientIP Preferred IP that should be given to the client if it is unallocated
* \param[in] TransactionID Transaction ID the created transaction should be associated with
*
* \return Size in bytes of the created DHCP packet

View file

@ -157,7 +157,7 @@ void DataflashManager_WriteBlocks(USB_ClassInfo_MS_Device_t* const MSInterfaceIn
return;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}
@ -371,7 +371,7 @@ void DataflashManager_WriteBlocks_RAM(const uint32_t BlockAddress,
BytesInBlockDiv16++;
}
/* Decrement the blocks remaining counter and reset the sub block counter */
/* Decrement the blocks remaining counter */
TotalBlocks--;
}

View file

@ -47,7 +47,7 @@ const char PROGMEM HTTP200Header[] = "HTTP/1.1 200 OK\r\n"
"Content-Type: ";
/** HTTP server response header, for transmission before a resource not found error. This indicates to the host that the given
* given URL is invalid, and gives extra error information.
* URL is invalid, and gives extra error information.
*/
const char PROGMEM HTTP404Header[] = "HTTP/1.1 404 Not Found\r\n"
"Server: LUFA " LUFA_VERSION_STRING "\r\n"

View file

@ -54,7 +54,7 @@ const char PROGMEM TELNETMenu[] = "\r\n"
/** Header to print before the current connections are printed to the client */
const char PROGMEM CurrentConnectionsHeader[] = "\r\n* Current TCP Connections: *\r\n";
/** Initialization function for the simple HTTP webserver. */
/** Initialization function for the simple TELNET webserver. */
void TELNETServerApp_Init(void)
{
/* Listen on port 23 for TELNET connections from hosts */

View file

@ -74,7 +74,7 @@ timer_set(struct timer *t, clock_time_t interval)
* given to the timer_set() function. The start point of the interval
* is the exact time that the timer last expired. Therefore, this
* function will cause the timer to be stable over time, unlike the
* timer_rester() function.
* timer_restart() function.
*
* \param t A pointer to the timer.
*

View file

@ -933,7 +933,7 @@ struct uip_udp_conn *uip_udp_new(const uip_ipaddr_t *ripaddr, u16_t rport);
} while(0)
/**
* Construct an IPv6 address from eight 8-bit words.
* Construct an IPv6 address from sixteen 8-bit words.
*
* This function constructs an IPv6 address.
*

View file

@ -282,15 +282,15 @@
*/
/**
* Toggles whether UDP support should be compiled in or not.
* Toggles whether TCP support should be compiled in or not.
*
* \hideinitializer
*/
#ifdef UIP_CONF_TCP
#define UIP_TCP UIP_CONF_TCP
#else /* UIP_CONF_UDP */
#else /* UIP_CONF_TCP */
#define UIP_TCP 1
#endif /* UIP_CONF_UDP */
#endif /* UIP_CONF_TCP */
/**
* Determines if support for opening connections from uIP should be