Commit 664a2921 authored by Dean Camera's avatar Dean Camera
Browse files

Application documentation/comment cleanup.

parent bdedbd55
......@@ -36,7 +36,6 @@
#define INCLUDE_FROM_BOOTLOADERCDC_C
#include "BootloaderCDC.h"
/* Globals: */
/** Line coding options for the virtual serial port. Although the virtual serial port data is never
* sent through a physical serial port, the line encoding data must still be read and preserved from
* the host, or the host will detect a problem and fail to open the port. This structure contains the
......
......@@ -37,7 +37,7 @@
#include "BootloaderMIDI.h"
/** Main program entry point. This routine configures the hardware required by the application, then
* starts the scheduler to run the application tasks.
* enters a loop to run the application tasks in sequence.
*/
int main(void)
{
......
......@@ -37,7 +37,7 @@
#include "MIDI.h"
/** Main program entry point. This routine configures the hardware required by the application, then
* starts the scheduler to run the application tasks.
* enters a loop to run the application tasks in sequence.
*/
int main(void)
{
......
......@@ -35,7 +35,6 @@
#include "TeensyHID.h"
/* Global Variables: */
/** Flag to indicate if the bootloader should be running, or should exit and allow the application code to run
* via a soft reset. When cleared, the bootloader will abort, the USB interface will shut down and the application
* started via a forced watchdog reset.
......
......@@ -37,7 +37,6 @@
#include "Ethernet.h"
/* Global Variables: */
/** Constant for convenience when checking against or setting a MAC address to the virtual server MAC address. */
const MAC_Address_t ServerMACAddress = {SERVER_MAC_ADDRESS};
......
......@@ -38,7 +38,6 @@
#define INCLUDE_FROM_TCP_C
#include "TCP.h"
/* Global Variables: */
/** Port state table array. This contains the current status of TCP ports in the device. To save on space, only open ports are
* stored - closed ports may be overwritten at any time, and the system will assume any ports not present in the array are closed. This
* allows for MAX_OPEN_TCP_PORTS to be less than the number of ports used by the application if desired.
......
......@@ -36,7 +36,6 @@
#include "CDC.h"
/* Globals: */
/** Contains the current baud rate and other settings of the virtual serial port. While this demo does not use
* the physical USART and thus does not use these settings, they must still be retained and returned to the host
* upon request or the host will assume the device is non-functional.
......@@ -50,6 +49,7 @@ CDC_Line_Coding_t LineEncoding = { .BaudRateBPS = 0,
.ParityType = Parity_None,
.DataBits = 8 };
#if 0
/* NOTE: Here you can set up a standard stream using the created virtual serial port, so that the standard stream functions in
* <stdio.h> can be used on the virtual serial port (e.g. fprintf(&USBSerial, "Test"); to print a string).
......
......@@ -36,7 +36,6 @@
#include "DualCDC.h"
/* Globals: */
/** Contains the current baud rate and other settings of the first virtual serial port. While this demo does not use
* the physical USART and thus does not use these settings, they must still be retained and returned to the host
* upon request or the host will assume the device is non-functional.
......@@ -63,8 +62,9 @@ CDC_Line_Coding_t LineEncoding2 = { .BaudRateBPS = 0,
.ParityType = Parity_None,
.DataBits = 8 };
/** Main program entry point. This routine configures the hardware required by the application, then
* starts the scheduler to run the application tasks.
* enters a loop to run the application tasks in sequence.
*/
int main(void)
{
......
......@@ -41,7 +41,7 @@ static uint8_t LastReceived[GENERIC_REPORT_SIZE];
/** Main program entry point. This routine configures the hardware required by the application, then
* starts the scheduler to run the USB management task.
* enters a loop to run the application tasks in sequence.
*/
int main(void)
{
......
......@@ -37,7 +37,7 @@
#include "Joystick.h"
/** Main program entry point. This routine configures the hardware required by the application, then
* starts the scheduler to run the application tasks.
* enters a loop to run the application tasks in sequence.
*/
int main(void)
{
......
......@@ -37,7 +37,6 @@
#include "Keyboard.h"
/* Global Variables */
/** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot
* protocol reporting mode.
*/
......@@ -56,7 +55,7 @@ uint16_t IdleMSRemaining = 0;
/** Main program entry point. This routine configures the hardware required by the application, then
* starts the scheduler to run the USB management task.
* enters a loop to run the application tasks in sequence.
*/
int main(void)
{
......
......@@ -37,15 +37,15 @@
#include "KeyboardMouse.h"
/* Global Variables */
/** Global structure to hold the current keyboard interface HID report, for transmission to the host */
USB_KeyboardReport_Data_t KeyboardReportData;
/** Global structure to hold the current mouse interface HID report, for transmission to the host */
USB_MouseReport_Data_t MouseReportData;
/** Main program entry point. This routine configures the hardware required by the application, then
* starts the scheduler to run the USB management task.
* enters a loop to run the application tasks in sequence.
*/
int main(void)
{
......
......@@ -37,7 +37,7 @@
#include "MIDI.h"
/** Main program entry point. This routine configures the hardware required by the application, then
* starts the scheduler to run the application tasks.
* enters a loop to run the application tasks in sequence.
*/
int main(void)
{
......
......@@ -37,7 +37,6 @@
#define INCLUDE_FROM_MASSSTORAGE_C
#include "MassStorage.h"
/* Global Variables */
/** Structure to hold the latest Command Block Wrapper issued by the host, containing a SCSI command to execute. */
CommandBlockWrapper_t CommandBlock;
......@@ -47,8 +46,9 @@ CommandStatusWrapper_t CommandStatus = { .Signature = CSW_SIGNATURE };
/** Flag to asynchronously abort any in-progress data transfers upon the reception of a mass storage reset command. */
volatile bool IsMassStoreReset = false;
/** Main program entry point. This routine configures the hardware required by the application, then
* starts the scheduler to run the application tasks.
* enters a loop to run the application tasks in sequence.
*/
int main(void)
{
......
......@@ -36,7 +36,6 @@
#include "Mouse.h"
/* Global Variables */
/** Indicates what report mode the host has requested, true for normal HID reporting mode, false for special boot
* protocol reporting mode.
*/
......@@ -55,7 +54,7 @@ uint16_t IdleMSRemaining = 0;
/** Main program entry point. This routine configures the hardware required by the application, then
* starts the scheduler to run the application tasks.
* enters a loop to run the application tasks in sequence.
*/
int main(void)
{
......
......@@ -37,7 +37,6 @@
#include "Ethernet.h"
/* Global Variables: */
/** Ethernet Frame buffer structure, to hold the incoming Ethernet frame from the host. */
Ethernet_Frame_Info_t FrameIN;
......
......@@ -37,7 +37,6 @@
#define INCLUDE_FROM_RNDIS_C
#include "RNDIS.h"
/* Global Variables: */
/** Physical MAC address of the network adapter, which becomes the MAC address of the host for packets sent to the adapter. */
static MAC_Address_t PROGMEM AdapterMACAddress = {ADAPTER_MAC_ADDRESS};
......
......@@ -38,7 +38,6 @@
#define INCLUDE_FROM_TCP_C
#include "TCP.h"
/* Global Variables: */
/** Port state table array. This contains the current status of TCP ports in the device. To save on space, only open ports are
* stored - closed ports may be overwritten at any time, and the system will assume any ports not present in the array are closed. This
* allows for MAX_OPEN_TCP_PORTS to be less than the number of ports used by the application if desired.
......
......@@ -37,7 +37,7 @@
#include "RNDISEthernet.h"
/** Main program entry point. This routine configures the hardware required by the application, then
* starts the scheduler to run the USB management task.
* enters a loop to run the application tasks in sequence.
*/
int main(void)
{
......
......@@ -30,7 +30,6 @@
#include "USBtoSerial.h"
/* Globals: */
/** Contains the current baud rate and other settings of the virtual serial port.
*
* These values are set by the host via a class-specific request, and the physical USART should be reconfigured to match the
......@@ -50,8 +49,9 @@ RingBuff_t Tx_Buffer;
/** Flag to indicate if the USART is currently transmitting data from the Rx_Buffer circular buffer. */
volatile bool Transmitting = false;
/** Main program entry point. This routine configures the hardware required by the application, then
* starts the scheduler to run the application tasks.
* enters a loop to run the application tasks in sequence.
*/
int main(void)
{
......
Markdown is supported
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