summaryrefslogtreecommitdiff
path: root/mcc_generated_files/usb/usb_common/usb_core_transfer.c
blob: 8d82f24017065976e19b479d3e0bc18a349b589d (plain)
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/**
 * USBCORETRANSFER USB Core Transfer Source File
 * @file usb_core_transfer.c
 * @ingroup usb_core_transfer
 * @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.
 */

#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
#include <string.h>

#include <usb_core.h>
#include <usb_protocol_headers.h>
#include <usb_common_elements.h>
#include <usb_config.h>
#include <usb_peripheral.h>

RETURN_CODE_t USB_TransferWriteStart(USB_PIPE_t pipe, uint8_t *dataPtr, uint16_t dataSize, bool useZLP, USB_TRANSFER_END_CALLBACK_t callback)
{
    RETURN_CODE_t status = UNINITIALIZED;

    if (USB_PipeStatusIsBusy(pipe) == true)
    {
        status = PIPE_BUSY_ERROR;
    }
    else
    {
        status = USB_PipeReset(pipe);
    }

    if (status == SUCCESS)
    {
        USB_PipeDataPtrSet(pipe, dataPtr);
        USB_PipeDataToTransferSizeSet(pipe, dataSize);
        USB_PipeDataTransferredSizeReset(pipe);
        if (true == useZLP)
        {
            USB_PipeTransferZLP_Enable(pipe);
        }
        USB_PipeTransferEndCallbackRegister(pipe, callback);
        status = USB_InTransactionRun(pipe);
    }
    return status;
}

RETURN_CODE_t USB_TransferReadStart(USB_PIPE_t pipe, uint8_t *dataPtr, uint16_t dataSize, bool useZLP, USB_TRANSFER_END_CALLBACK_t callback)
{
    RETURN_CODE_t status = UNINITIALIZED;

    if (USB_PipeStatusIsBusy(pipe) == true)
    {
        status = PIPE_BUSY_ERROR;
    }
    else
    {
        status = USB_PipeReset(pipe);
    }

    if (status == SUCCESS)
    {
        USB_PipeDataPtrSet(pipe, dataPtr);
        USB_PipeDataToTransferSizeSet(pipe, dataSize);
        USB_PipeDataTransferredSizeReset(pipe);
        if (true == useZLP)
        {
            USB_PipeTransferZLP_Enable(pipe);
        }
        USB_PipeTransferEndCallbackRegister(pipe, callback);
        status = USB_OutTransactionRun(pipe);
    }

    return status;
}

RETURN_CODE_t USB_TransferControlDataSet(uint8_t *dataPtr, uint16_t dataSize, USB_SETUP_ENDOFREQUEST_CALLBACK_t callback)
{
    USB_ControlEndOfRequestCallbackRegister(callback);
    return USB_ControlTransferDataSet(dataPtr, dataSize);
}

RETURN_CODE_t USB_TransferAbort(USB_PIPE_t pipe)
{
    RETURN_CODE_t status = UNINITIALIZED;

    // Checks if abort is needed.
    if (USB_PipeStatusIsBusy(pipe) == true)
    {
        //Stops transfer.
        status = USB_TransactionAbort(pipe);

        if (status == SUCCESS)
        {
            // Calls callback.
            USB_PipeTransferEndCallback(pipe);
        }
    }
    else
    {
        // Pipe is not busy, so no need to abort.
        status = SUCCESS;
    }

    return status;
}

RETURN_CODE_t USB_TransferHandler(void)
{
    RETURN_CODE_t status = UNINITIALIZED;

    // If it's the initial setup packet, handle that separately.
    if (USB_SetupIsReceived() == true)
    {
        status = USB_ControlSetupReceived();
    }
    // If a transaction is complete, handle that one.
    else if (USB_TransactionIsCompleted() == true)
    {
        // Finds out which pipe has a completed transaction.
        USB_PIPE_t pipe;

        status = USB_TransactionCompletedPipeGet(&pipe);

        if (status == SUCCESS)
        {
            // Acks the transaction.
            status = USB_TransactionCompleteAck(pipe);
        }

        if (status == SUCCESS)
        {
            // Handles control transactions separately.
            if (pipe.address == 0U)
            {
                status = USB_ControlTransactionComplete(pipe);
            }
            else
            {
                // Regular handling of all regular endpoints.
                status = USB_PipeTransactionComplete(pipe);
            }
        }
    }
    else
    {
        // No handling needed, return SUCCESS.
        status = SUCCESS;
    }

    return status;
}