Fix typos and outdated information.

[pub/USBasp.git] / Bootloaders / CDC / BootloaderCDC.h

diff --git a/Bootloaders/CDC/BootloaderCDC.h b/Bootloaders/CDC/BootloaderCDC.h
index 7aa07a2..b445913 100644 (file)
--- a/Bootloaders/CDC/BootloaderCDC.h
+++ b/Bootloaders/CDC/BootloaderCDC.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2011.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -32,7 +32,7 @@
  *
  *  Header file for BootloaderCDC.c.
  */
  *
  *  Header file for BootloaderCDC.c.
  */

- 
+

 #ifndef _CDC_H_
 #define _CDC_H_
 
 #ifndef _CDC_H_
 #define _CDC_H_
 


@@ -49,13 +49,13 @@
 
                #include <LUFA/Drivers/USB/USB.h>
 
 
                #include <LUFA/Drivers/USB/USB.h>
 

-       /* Macros: */           
+       /* Macros: */

                /** Version major of the CDC bootloader. */
                #define BOOTLOADER_VERSION_MAJOR     0x01
 
                /** Version minor of the CDC bootloader. */
                #define BOOTLOADER_VERSION_MINOR     0x00
                /** Version major of the CDC bootloader. */
                #define BOOTLOADER_VERSION_MAJOR     0x01
 
                /** Version minor of the CDC bootloader. */
                #define BOOTLOADER_VERSION_MINOR     0x00

-                               
+

                /** Hardware version major of the CDC bootloader. */
                #define BOOTLOADER_HWVERSION_MAJOR   0x01
 
                /** Hardware version major of the CDC bootloader. */
                #define BOOTLOADER_HWVERSION_MAJOR   0x01
 


@@ -64,11 +64,51 @@
 
                /** Eight character bootloader firmware identifier reported to the host when requested */
                #define SOFTWARE_IDENTIFIER          "LUFACDC"
 
                /** Eight character bootloader firmware identifier reported to the host when requested */
                #define SOFTWARE_IDENTIFIER          "LUFACDC"

-               
+
+               /** CDC Class specific request to get the current virtual serial port configuration settings. */
+               #define REQ_GetLineEncoding          0x21
+
+               /** CDC Class specific request to set the current virtual serial port configuration settings. */
+               #define REQ_SetLineEncoding          0x20
+

        /* Type Defines: */
        /* Type Defines: */

+               /** Type define for the virtual serial port line encoding settings, for storing the current USART configuration
+                *  as set by the host via a class specific request.
+                */
+               typedef struct
+               {
+                       uint32_t BaudRateBPS; /**< Baud rate of the virtual serial port, in bits per second */
+                       uint8_t  CharFormat; /**< Character format of the virtual serial port, a value from the
+                                             *   CDCDevice_CDC_LineCodingFormats_t enum
+                                             */
+                       uint8_t  ParityType; /**< Parity setting of the virtual serial port, a value from the
+                                             *   CDCDevice_LineCodingParity_t enum
+                                             */
+                       uint8_t  DataBits; /**< Bits of data per character of the virtual serial port */
+               } CDC_Line_Coding_t;
+

                /** Type define for a non-returning pointer to the start of the loaded application in flash memory. */
                typedef void (*AppPtr_t)(void) ATTR_NO_RETURN;
                /** Type define for a non-returning pointer to the start of the loaded application in flash memory. */
                typedef void (*AppPtr_t)(void) ATTR_NO_RETURN;

-               
+
+       /* Enums: */
+               /** Enum for the possible line encoding formats of a virtual serial port. */
+               enum CDCDevice_CDC_LineCodingFormats_t
+               {
+                       OneStopBit          = 0, /**< Each frame contains one stop bit */
+                       OneAndAHalfStopBits = 1, /**< Each frame contains one and a half stop bits */
+                       TwoStopBits         = 2, /**< Each frame contains two stop bits */
+               };
+
+               /** Enum for the possible line encoding parity settings of a virtual serial port. */
+               enum CDCDevice_LineCodingParity_t
+               {
+                       Parity_None         = 0, /**< No parity bit mode on each frame */
+                       Parity_Odd          = 1, /**< Odd parity bit mode on each frame */
+                       Parity_Even         = 2, /**< Even parity bit mode on each frame */
+                       Parity_Mark         = 3, /**< Mark parity bit mode on each frame */
+                       Parity_Space        = 4, /**< Space parity bit mode on each frame */
+               };
+

        /* Function Prototypes: */
                void CDC_Task(void);
                void SetupHardware(void);
        /* Function Prototypes: */
                void CDC_Task(void);
                void SetupHardware(void);


@@ -76,9 +116,12 @@
                void EVENT_USB_Device_ConfigurationChanged(void);
 
                #if defined(INCLUDE_FROM_BOOTLOADERCDC_C) || defined(__DOXYGEN__)
                void EVENT_USB_Device_ConfigurationChanged(void);
 
                #if defined(INCLUDE_FROM_BOOTLOADERCDC_C) || defined(__DOXYGEN__)

+                       #if !defined(NO_BLOCK_SUPPORT)

                        static void    ReadWriteMemoryBlock(const uint8_t Command);
                        static void    ReadWriteMemoryBlock(const uint8_t Command);

+                       #endif

                        static uint8_t FetchNextCommandByte(void);
                        static void    WriteNextResponseByte(const uint8_t Response);
                #endif
 
 #endif
                        static uint8_t FetchNextCommandByte(void);
                        static void    WriteNextResponseByte(const uint8_t Response);
                #endif
 
 #endif

+