nrf_dfu_trigger_usb.h 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. /**
  2. * Copyright (c) 2017 - 2020, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. #ifndef NRF_DFU_TRIGGER_USB_H
  41. #define NRF_DFU_TRIGGER_USB_H
  42. #include "sdk_errors.h"
  43. /**
  44. * @defgroup nrf_dfu_trigger_usb USB DFU trigger library
  45. * @ingroup app_common
  46. *
  47. * @brief @tagAPI52840 USB DFU trigger library is used to enter the bootloader and read the firmware version.
  48. *
  49. * @details See @ref lib_dfu_trigger_usb for additional documentation.
  50. * @{
  51. */
  52. /**
  53. * @brief Function for initializing the USB DFU trigger library.
  54. *
  55. * @note If the USB is also used for other purposes, then this function must be called after USB is
  56. * initialized but before it is enabled. In this case, the configuration flag @ref
  57. * NRF_DFU_TRIGGER_USB_USB_SHARED must be set to 1.
  58. *
  59. * @note Calling this again after the first success has no effect and returns @ref NRF_SUCCESS.
  60. *
  61. * @note If @ref APP_USBD_CONFIG_EVENT_QUEUE_ENABLE is on (1), USB events must be handled manually.
  62. * See @ref app_usbd_event_queue_process.
  63. *
  64. * @retval NRF_SUCCESS On successful initialization.
  65. * @return An error code on failure, for example if called at a wrong time.
  66. */
  67. ret_code_t nrf_dfu_trigger_usb_init(void);
  68. /** @} */
  69. #endif //NRF_DFU_TRIGGER_USB_H