Documentation improvements - put driver example code into its own section, fix incorr...

[pub/USBasp.git] / Demos / Device / Incomplete / Sideshow / Sideshow.c

diff --git a/Demos/Device/Incomplete/Sideshow/Sideshow.c b/Demos/Device/Incomplete/Sideshow/Sideshow.c
index 644e957..8115cdb 100644 (file)
--- a/Demos/Device/Incomplete/Sideshow/Sideshow.c
+++ b/Demos/Device/Incomplete/Sideshow/Sideshow.c
@@ -1,21 +1,21 @@
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.
 /*
              LUFA Library
      Copyright (C) Dean Camera, 2010.

-              
+

   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 2010  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


@@ -36,12 +36,12 @@
        externally connected interactive display. Upon enumeration, this will
        appear as a new SideShow device which can have gadgets loaded onto
        it.
        externally connected interactive display. Upon enumeration, this will
        appear as a new SideShow device which can have gadgets loaded onto
        it.

-       
+

        Note that while the incoming content is buffered in packet struct
        form, the data is not actually displayed. It is left to the user to
        write sufficient code to read out the packed data for display to a
        screen.
        Note that while the incoming content is buffered in packet struct
        form, the data is not actually displayed. It is left to the user to
        write sufficient code to read out the packed data for display to a
        screen.

-       
+

        Installed gadgets can be accessed through the InstalledApplications
        array, with entries that have their InUse flag set being active. As
        only the active content is displayed on the device due to memory
        Installed gadgets can be accessed through the InstalledApplications
        array, with entries that have their InUse flag set being active. As
        only the active content is displayed on the device due to memory


@@ -59,7 +59,7 @@ int main(void)
 
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        sei();
 
        LEDs_SetAllLEDs(LEDMASK_USB_NOTREADY);
        sei();

-       
+

        for (;;)
        {
                SideShow_Task();
        for (;;)
        {
                SideShow_Task();


@@ -76,7 +76,7 @@ void SetupHardware(void)
 
        /* Disable clock division */
        clock_prescale_set(clock_div_1);
 
        /* Disable clock division */
        clock_prescale_set(clock_div_1);

-       
+

        /* Hardware Initialization */
        LEDs_Init();
        USB_Init();
        /* Hardware Initialization */
        LEDs_Init();
        USB_Init();


@@ -107,22 +107,23 @@ void EVENT_USB_Device_ConfigurationChanged(void)
        LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 }
 
        LEDs_SetAllLEDs(ConfigSuccess ? LEDMASK_USB_READY : LEDMASK_USB_ERROR);
 }
 

-void EVENT_USB_Device_UnhandledControlRequest(void)
+void EVENT_USB_Device_ControlRequest(void)

 {
        switch (USB_ControlRequest.bRequest)
        {
                case REQ_GetOSFeatureDescriptor:
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_VENDOR | REQREC_DEVICE))
                        {
 {
        switch (USB_ControlRequest.bRequest)
        {
                case REQ_GetOSFeatureDescriptor:
                        if (USB_ControlRequest.bmRequestType == (REQDIR_DEVICETOHOST | REQTYPE_VENDOR | REQREC_DEVICE))
                        {

-                               void*    DescriptorPointer;
-                               uint16_t DescriptorSize = USB_GetOSFeatureDescriptor(USB_ControlRequest.wValue, USB_ControlRequest.wIndex,
-                                                                                    &DescriptorPointer);
+                               const void* DescriptorPointer;
+                               uint16_t    DescriptorSize = USB_GetOSFeatureDescriptor(USB_ControlRequest.wValue,
+                                                                                       USB_ControlRequest.wIndex,
+                                                                                       &DescriptorPointer);

 
                                if (DescriptorSize == NO_DESCRIPTOR)
                                  return;
 
                                if (DescriptorSize == NO_DESCRIPTOR)
                                  return;

-                               
+

                                Endpoint_ClearSETUP();
                                Endpoint_ClearSETUP();

-                               
+

                                Endpoint_Write_Control_PStream_LE(DescriptorPointer, DescriptorSize);
                                Endpoint_ClearOUT();
                        }
                                Endpoint_Write_Control_PStream_LE(DescriptorPointer, DescriptorSize);
                                Endpoint_ClearOUT();
                        }


@@ -130,7 +131,7 @@ void EVENT_USB_Device_UnhandledControlRequest(void)
                        break;
        }
 }
                        break;
        }
 }

-       
+

 void SideShow_Task(void)
 {
        /* Device must be connected and configured for the task to run */
 void SideShow_Task(void)
 {
        /* Device must be connected and configured for the task to run */


@@ -139,7 +140,7 @@ void SideShow_Task(void)
 
        /* Select the SideShow data out endpoint */
        Endpoint_SelectEndpoint(SIDESHOW_OUT_EPNUM);
 
        /* Select the SideShow data out endpoint */
        Endpoint_SelectEndpoint(SIDESHOW_OUT_EPNUM);

-       
+

        /* Check to see if a new SideShow message has been received */
        if (Endpoint_IsReadWriteAllowed())
        {
        /* Check to see if a new SideShow message has been received */
        if (Endpoint_IsReadWriteAllowed())
        {


@@ -147,3 +148,4 @@ void SideShow_Task(void)
                Sideshow_ProcessCommandPacket();
        }
 }
                Sideshow_ProcessCommandPacket();
        }
 }

+