1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/**
* USBCORETRANSFER USB Core Transfer Header File
* @file usb_core_transfer.h
* @defgroup usb_core_transfer USB Core Transfer
* @ingroup usb_core
* @brief USB core layer implementation file.
* @version USB Core Version 1.0.0
*/
/*
(c) 2021 Microchip Technology Inc. and its subsidiaries.
Subject to your compliance with these terms, you may use Microchip software and any
derivatives exclusively with Microchip products. It is your responsibility to comply with third party
license terms applicable to your use of third party software (including open source software) that
may accompany Microchip software.
THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY
IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS
FOR A PARTICULAR PURPOSE.
IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP
HAS BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO
THE FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL
CLAIMS IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT
OF FEES, IF ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS
SOFTWARE.
*/
#ifndef USB_CORE_TRANSFER_H
// cppcheck-suppress misra-c2012-2.5
#define USB_CORE_TRANSFER_H
#include <stdbool.h>
#include <stdint.h>
#include <usb_protocol_headers.h>
#include <usb_common_elements.h>
#include <usb_core_transfer.h>
#include <usb_core_requests.h>
#include <usb_core_descriptors.h>
#include <usb_peripheral.h>
/**
* @ingroup usb_core_transfer
* @brief Sets up the pipe for the write transfers.
*
* Sets up the pipe for the write transfers and checks to see if it is busy. If it is not busy, then the routine resets the pipe, setting it up for write transfer, then starts the transfer.
*
* @param pipe - A combination of endpoint address and direction
* @param *dataPtr - The pointer to the data to write
* @param dataSize - The size of the data to write
* @param useZLP - Enable zero-length package at the end of transfer
* @param callback - A combination of pipe, status and transferred bytes
* @return SUCCESS or an Error code according to RETURN_CODE_t
*/
RETURN_CODE_t USB_TransferWriteStart(USB_PIPE_t pipe, uint8_t *dataPtr, uint16_t dataSize, bool useZLP, USB_TRANSFER_END_CALLBACK_t callback);
/**
* @ingroup usb_core_transfer
* @brief Sets up the pipe for the read transfers.
*
* Sets up the pipe for the write transfers and checks to see if it is busy. If it is not busy, then the routine resets the pipe, setting it up for read transfer, then starts the transfer.
*
* @param pipe - A combination of endpoint address and direction
* @param *dataPtr - The pointer to the data to read
* @param dataSize - The size of the data to read
* @param useZLP - Enable zero-length package at the end of transfer
* @param callback - A combination of pipe, status and transferred bytes
* @return SUCCESS or an Error code according to RETURN_CODE_t
*/
RETURN_CODE_t USB_TransferReadStart(USB_PIPE_t pipe, uint8_t *dataPtr, uint16_t dataSize, bool useZLP, USB_TRANSFER_END_CALLBACK_t callback);
/**
* @ingroup usb_core_transfer
* @brief Sets up vendor or class control request data transfers.
*
* Sets up the pointer and size of the read or write trnasfer in the control data stage.
*
* @param *dataPtr - The pointer to the data to read or write
* @param dataSize - The size of the data to read or write
* @param callback - Pointer to a function to be called at the end of the control request
* @return SUCCESS or an Error code according to RETURN_CODE_t
*/
RETURN_CODE_t USB_TransferControlDataSet(uint8_t *dataPtr, uint16_t dataSize, USB_SETUP_ENDOFREQUEST_CALLBACK_t callback);
/**
* @ingroup usb_core_transfer
* @brief Aborts an ongoing transfer.
*
* Will call the pipe transferEndCallback with the abort status, if configured.
*
* @param pipe - A combination of endpoint address and direction
* @return SUCCESS or an Error code according to RETURN_CODE_t
*/
RETURN_CODE_t USB_TransferAbort(USB_PIPE_t pipe);
/**
* @ingroup usb_core_transfer
* @brief Handles the different types of packages received or transferred.
*
* Checks if a setup package is received or if a transaction is completed and which pipe has a completed transaction, then it handles them accordingly.
* Sends an ACK upon completed transaction confirmation.
*
* @param None.
* @return SUCCESS or an Error code according to RETURN_CODE_t
*/
RETURN_CODE_t USB_TransferHandler(void);
#endif /* USB_CORE_TRANSFER_H */
|
