summaryrefslogtreecommitdiff
path: root/common/usbx_host_classes/src/ux_host_class_cdc_acm_transmission_callback.c
blob: fc988c8a64bf5a60f8ea732f90440f7dacdd79f4 (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
/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 * Copyright (c) 2026-present Eclipse ThreadX contributors
 *
 * This program and the accompanying materials are made available under the
 * terms of the MIT License which is available at
 * https://opensource.org/licenses/MIT.
 *
 * SPDX-License-Identifier: MIT
 **************************************************************************/


/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** USBX Component                                                        */
/**                                                                       */
/**   ACM CDC Class                                                       */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/


/* Include necessary system files.  */

#define UX_SOURCE_CODE

#include "ux_api.h"
#include "ux_host_class_cdc_acm.h"
#include "ux_host_stack.h"


#if defined(UX_HOST_STANDALONE)
/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_host_class_cdc_acm_transmission_callback        PORTABLE C      */
/*                                                           6.1.10       */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function is the callback from the USBX transfer functions,     */
/*    it is called when a full or partial transfer has been done for a    */
/*    bulk in transfer. It calls back the application.                    */
/*                                                                        */
/*    It's for standalone mode.                                           */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    transfer_request                      Pointer to transfer request   */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_host_stack_transfer_run           Process transfer request      */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*                                                                        */
/**************************************************************************/
VOID  _ux_host_class_cdc_acm_transmission_callback(UX_TRANSFER *transfer_request)
{

UX_HOST_CLASS_CDC_ACM   *cdc_acm;
ULONG                   request_length;
VOID                    (*write_callback)(struct UX_HOST_CLASS_CDC_ACM_STRUCT *, UINT, ULONG);

    /* Get the class instance for this transfer request.  */
    cdc_acm = (UX_HOST_CLASS_CDC_ACM *) transfer_request -> ux_transfer_request_class_instance;

    /* Check the state of the transfer.  If there is an error, we do not proceed with this report.  */
    if (transfer_request -> ux_transfer_request_completion_code == UX_SUCCESS)
    {

        /* Update write information.  */
        cdc_acm -> ux_host_class_cdc_acm_write_count +=
                        transfer_request -> ux_transfer_request_actual_length;

        /* Check if there is remaining.  */
        request_length = cdc_acm -> ux_host_class_cdc_acm_write_length -
                                 cdc_acm -> ux_host_class_cdc_acm_write_count;
        if (request_length > 0)
        {

            /* Program the maximum authorized length for this transfer_request.  */
            if (request_length > transfer_request -> ux_transfer_request_maximum_length)
                request_length =  transfer_request -> ux_transfer_request_maximum_length;

            /* Update buffer pointer and request length.  */
            transfer_request -> ux_transfer_request_data_pointer +=
                        transfer_request -> ux_transfer_request_actual_length;
            transfer_request -> ux_transfer_request_requested_length = request_length;
            UX_TRANSFER_STATE_RESET(transfer_request);

            /* Arm another transfer.  */
            _ux_host_stack_transfer_run(transfer_request);

            /* There is no status to be reported back to the stack.  */
            return;
        }
    }

    /* There is error, or total things done, set state to idle.  */
    cdc_acm -> ux_host_class_cdc_acm_write_state = UX_STATE_RESET;

    /* Clear callback for blocking mode.  */
    write_callback = cdc_acm -> ux_host_class_cdc_acm_write_callback;
    cdc_acm -> ux_host_class_cdc_acm_write_callback = UX_NULL;

    /* We need to report this transfer to the application.  */
    if (write_callback)
    {
        write_callback(cdc_acm,
                    transfer_request -> ux_transfer_request_completion_code,
                    cdc_acm -> ux_host_class_cdc_acm_write_count);
    }

    /* There is no status to be reported back to the stack.  */
    return;
}
#endif