Kévin Redon | 69b92d9 | 2019-01-24 16:39:20 +0100 | [diff] [blame] | 1 | /** |
| 2 | * \file |
| 3 | * |
| 4 | * \brief USB Device Stack CDC ACM Function Definition. |
| 5 | * |
| 6 | * Copyright (c) 2015-2018 Microchip Technology Inc. and its subsidiaries. |
| 7 | * |
| 8 | * \asf_license_start |
| 9 | * |
| 10 | * \page License |
| 11 | * |
| 12 | * Subject to your compliance with these terms, you may use Microchip |
| 13 | * software and any derivatives exclusively with Microchip products. |
| 14 | * It is your responsibility to comply with third party license terms applicable |
| 15 | * to your use of third party software (including open source software) that |
| 16 | * may accompany Microchip software. |
| 17 | * |
| 18 | * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, |
| 19 | * WHETHER EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, |
| 20 | * INCLUDING ANY IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, |
| 21 | * AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT WILL MICROCHIP BE |
| 22 | * LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL OR CONSEQUENTIAL |
| 23 | * LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND WHATSOEVER RELATED TO THE |
| 24 | * SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS BEEN ADVISED OF THE |
| 25 | * POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE FULLEST EXTENT |
| 26 | * ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS IN ANY WAY |
| 27 | * RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF ANY, |
| 28 | * THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE. |
| 29 | * |
| 30 | * \asf_license_stop |
| 31 | */ |
| 32 | |
| 33 | #ifndef USBDF_CDC_ACM_SER_H_ |
| 34 | #define USBDF_CDC_ACM_SER_H_ |
| 35 | |
| 36 | #include "usbdc.h" |
| 37 | #include "usb_protocol_cdc.h" |
| 38 | |
| 39 | /** CDC ACM Class Callback Type */ |
| 40 | enum cdcdf_acm_cb_type { CDCDF_ACM_CB_READ, CDCDF_ACM_CB_WRITE, CDCDF_ACM_CB_LINE_CODING_C, CDCDF_ACM_CB_STATE_C }; |
| 41 | |
| 42 | /** CDC ACM Notify Line State Callback. */ |
| 43 | typedef void (*cdcdf_acm_notify_state_t)(uint16_t); |
| 44 | |
| 45 | /** CDC ACM Set Line Coding Callback. */ |
| 46 | typedef bool (*cdcdf_acm_set_line_coding_t)(struct usb_cdc_line_coding *); |
| 47 | |
| 48 | /** |
| 49 | * \brief Initialize the USB CDC ACM Function Driver |
| 50 | * \return Operation status. |
| 51 | */ |
| 52 | int32_t cdcdf_acm_init(void); |
| 53 | |
| 54 | /** |
| 55 | * \brief Deinitialize the USB CDC ACM Function Driver |
| 56 | * \return Operation status. |
| 57 | */ |
| 58 | void cdcdf_acm_deinit(void); |
| 59 | |
| 60 | /** |
| 61 | * \brief USB CDC ACM Function Read Data |
| 62 | * \param[in] buf Pointer to the buffer which receives data |
| 63 | * \param[in] size the size of data to be received |
| 64 | * \return Operation status. |
| 65 | */ |
| 66 | int32_t cdcdf_acm_read(uint8_t *buf, uint32_t size); |
| 67 | |
| 68 | /** |
| 69 | * \brief USB CDC ACM Function Write Data |
| 70 | * \param[in] buf Pointer to the buffer which stores data |
| 71 | * \param[in] size the size of data to be sent |
| 72 | * \return Operation status. |
| 73 | */ |
| 74 | int32_t cdcdf_acm_write(uint8_t *buf, uint32_t size); |
| 75 | |
| 76 | /** |
| 77 | * \brief USB CDC ACM Stop the currnet data transfer |
| 78 | */ |
| 79 | void cdcdf_acm_stop_xfer(void); |
| 80 | |
| 81 | /** |
| 82 | * \brief USB CDC ACM Function Register Callback |
| 83 | * \param[in] cb_type Callback type of CDC ACM Function |
| 84 | * \param[in] func Pointer to callback function |
| 85 | * \return Operation status. |
| 86 | */ |
| 87 | int32_t cdcdf_acm_register_callback(enum cdcdf_acm_cb_type cb_type, FUNC_PTR func); |
| 88 | |
| 89 | /** |
| 90 | * \brief Check whether CDC ACM Function is enabled |
| 91 | * \return Operation status. |
| 92 | * \return true CDC ACM Function is enabled |
| 93 | * \return false CDC ACM Function is disabled |
| 94 | */ |
| 95 | bool cdcdf_acm_is_enabled(void); |
| 96 | |
| 97 | /** |
| 98 | * \brief Return the CDC ACM line coding structure start address |
| 99 | * \return Pointer to USB CDC ACM line coding data. |
| 100 | */ |
| 101 | const struct usb_cdc_line_coding *cdcdf_acm_get_line_coding(void); |
| 102 | |
| 103 | /** |
| 104 | * \brief Return version |
| 105 | */ |
| 106 | uint32_t cdcdf_acm_get_version(void); |
| 107 | |
| 108 | #endif /* USBDF_CDC_ACM_SER_H_ */ |