vfs_tinyusb.h 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. // Copyright 2020 Espressif Systems (Shanghai) Co. Ltd.
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. //
  7. // http://www.apache.org/licenses/LICENSE-2.0
  8. //
  9. // Unless required by applicable law or agreed to in writing, software
  10. // distributed under the License is distributed on an "AS IS" BASIS,
  11. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. // See the License for the specific language governing permissions and
  13. // limitations under the License.
  14. #pragma once
  15. #include "esp_err.h"
  16. #ifdef __cplusplus
  17. extern "C" {
  18. #endif
  19. /**
  20. * @brief Register TinyUSB CDC at VFS with path
  21. * @param cdc_intf - interface number of TinyUSB's CDC
  22. * @param path - path where the CDC will be registered, `/dev/tusb_cdc` will be used if left NULL.
  23. *
  24. * @return esp_err_t ESP_OK or ESP_FAIL
  25. */
  26. esp_err_t esp_vfs_tusb_cdc_register(int cdc_intf, char const *path);
  27. /**
  28. * @brief Unregister TinyUSB CDC from VFS
  29. * @param path - path where the CDC will be unregistered if NULL will be used `/dev/tusb_cdc`
  30. *
  31. * @return esp_err_t ESP_OK or ESP_FAIL
  32. */
  33. esp_err_t esp_vfs_tusb_cdc_unregister(char const *path);
  34. #ifdef __cplusplus
  35. }
  36. #endif