readme.txt 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. /*!
  2. \file readme.txt
  3. \brief description of the the USB HID/printer composite demo
  4. \version 2023-06-30, V2.1.6, firmware for GD32F30x
  5. */
  6. /*
  7. Copyright (c) 2023, GigaDevice Semiconductor Inc.
  8. Redistribution and use in source and binary forms, with or without modification,
  9. are permitted provided that the following conditions are met:
  10. 1. Redistributions of source code must retain the above copyright notice, this
  11. list of conditions and the following disclaimer.
  12. 2. Redistributions in binary form must reproduce the above copyright notice,
  13. this list of conditions and the following disclaimer in the documentation
  14. and/or other materials provided with the distribution.
  15. 3. Neither the name of the copyright holder nor the names of its contributors
  16. may be used to endorse or promote products derived from this software without
  17. specific prior written permission.
  18. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19. AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20. WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  22. INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23. NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24. PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  25. WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26. ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  27. OF SUCH DAMAGE.
  28. */
  29. This demo is based on the GD32307C-EVAL board, it provides a description of
  30. how to use the USBFS.
  31. The demo provide a composite device.
  32. A composite device is one that has multiple interfaces controlled independently
  33. of each other. Using composite device, multiple functions are combined into a single
  34. device. In this Example the independent interfaces are : custom HID and USB Printer.
  35. This demo was created by combining the code in the HID and USB Printer.
  36. The implementation of the composite HID-Printer device is done by creating a wrapping
  37. class (see folder hid_printer_wrapper ) that makes calls to the separate HID and USB
  38. Printer class layer handlers (files custom_hid_core.c and printer_core.c files).
  39. To test the demo, you can run HID demo and at same time you can select the
  40. USB Printer.
  41. When even one of the interface class of the device is changed, it should be handled
  42. differently by Windows. However, it doesn't recognize the modification. To avoid conflict
  43. on Windows, we suggest to assign another VID/PID to the device or delete device instance
  44. from device manager.