summaryrefslogtreecommitdiff
path: root/common/usbx_host_classes/src/ux_host_class_gser_command.c
blob: 204f86accf62412aa585149a825d8c6ccaec79d5 (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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   Generic Serial Host module class                                    */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/


/* Include necessary system files.  */

#define UX_SOURCE_CODE

#include "ux_api.h"
#include "ux_host_class_gser.h"
#include "ux_host_stack.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_host_class_gser_command                         PORTABLE C      */
/*                                                           6.3.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function will send a command to the ACM device. The command    */
/*    can be one of the following :                                       */
/*    SET_CONTROL                                                         */
/*    SET_LINE                                                            */
/*    SEND_BREAK                                                          */
/*                                                                        */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    acm                                   Pointer to acm class          */
/*    command                               command value                 */
/*    value                                 value to be sent in the       */
/*                                          command request               */
/*    data_buffer                           buffer to be sent             */
/*    data_length                           length of the buffer to send  */
/*                                                                        */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_host_stack_transfer_request       Process transfer request      */
/*    _ux_host_semaphore_get                Get semaphore                 */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*                                                                        */
/**************************************************************************/
UINT  _ux_host_class_gser_command(UX_HOST_CLASS_GSER *gser, ULONG interface_index, ULONG command,
                                    ULONG value, UCHAR *data_buffer, ULONG data_length)
{

UX_ENDPOINT     *control_endpoint;
UX_TRANSFER     *transfer_request;
UINT            status;
ULONG           request_direction;


    /* We need to get the default control endpoint transfer request pointer.  */
    control_endpoint =  &gser -> ux_host_class_gser_device -> ux_device_control_endpoint;
    transfer_request =  &control_endpoint -> ux_endpoint_transfer_request;

    /* Check the direction of the command.  */
    switch (command)
    {

        case UX_HOST_CLASS_GSER_REQ_SEND_ENCAPSULATED_COMMAND        :
        case UX_HOST_CLASS_GSER_REQ_SET_COMM_FEATURE                 :
        case UX_HOST_CLASS_GSER_REQ_CLEAR_COMM_FEATURE               :
        case UX_HOST_CLASS_GSER_REQ_SET_AUX_LINE_STATE               :
        case UX_HOST_CLASS_GSER_REQ_SET_HOOK_STATE                   :
        case UX_HOST_CLASS_GSER_REQ_PULSE_SETUP                      :
        case UX_HOST_CLASS_GSER_REQ_SEND_PULSE                       :
        case UX_HOST_CLASS_GSER_REQ_SET_PUSLE_TIME                   :
        case UX_HOST_CLASS_GSER_REQ_RING_AUX_JACK                    :
        case UX_HOST_CLASS_GSER_REQ_SET_LINE_CODING                  :
        case UX_HOST_CLASS_GSER_REQ_SET_LINE_STATE                   :
        case UX_HOST_CLASS_GSER_REQ_SEND_BREAK                       :
        case UX_HOST_CLASS_GSER_REQ_SET_RINGER_PARMS                 :
        case UX_HOST_CLASS_GSER_REQ_SET_OPERATION_PARMS              :
        case UX_HOST_CLASS_GSER_REQ_SET_LINE_PARMS                   :

            /* Direction is out */
            request_direction = UX_REQUEST_OUT;
            break;


        case UX_HOST_CLASS_GSER_REQ_GET_ENCAPSULATED_COMMAND         :
        case UX_HOST_CLASS_GSER_REQ_GET_COMM_FEATURE                 :
        case UX_HOST_CLASS_GSER_REQ_GET_LINE_CODING                  :
        case UX_HOST_CLASS_GSER_REQ_GET_RINGER_PARMS                 :
        case UX_HOST_CLASS_GSER_REQ_GET_OPERATION_PARMS              :
        case UX_HOST_CLASS_GSER_REQ_GET_LINE_PARMS                   :

            /* Direction is in */
            request_direction = UX_REQUEST_IN;
            break;


        default :

            return(UX_ERROR);

    }

    /* Protect the control endpoint semaphore here.  It will be unprotected in the
       transfer request function.  */
    status =  _ux_host_semaphore_get(&gser -> ux_host_class_gser_device -> ux_device_protection_semaphore, UX_WAIT_FOREVER);

    /* Check for status.  */
    if (status != UX_SUCCESS)

        /* Something went wrong. */
        return(status);

    /* Create a transfer_request for the request.  */
    transfer_request -> ux_transfer_request_data_pointer     =  data_buffer;
    transfer_request -> ux_transfer_request_requested_length =  data_length;
    transfer_request -> ux_transfer_request_function         =  command;
    transfer_request -> ux_transfer_request_type             =  request_direction | UX_REQUEST_TYPE_CLASS | UX_REQUEST_TARGET_INTERFACE;
    transfer_request -> ux_transfer_request_value            =  value;
    transfer_request -> ux_transfer_request_index            =  gser -> ux_host_class_gser_interface_array[interface_index].ux_host_class_gser_interface->ux_interface_descriptor.bInterfaceNumber;

    /* Send request to HCD layer.  */
    status =  _ux_host_stack_transfer_request(transfer_request);

    /* Return completion status.  */
    return(status);
}


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _uxe_host_class_gser_command                        PORTABLE C      */
/*                                                           6.3.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function checks errors in GSER command function call.          */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    gser                                  Pointer to GSER class         */
/*    command                               command value                 */
/*    value                                 value to be sent in the       */
/*                                          command request               */
/*    data_buffer                           buffer to be sent             */
/*    data_length                           length of the buffer to send  */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Status                                                              */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_host_class_gser_command           Send GSER request             */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Application                                                         */
/*                                                                        */
/**************************************************************************/
UINT  _uxe_host_class_gser_command(UX_HOST_CLASS_GSER *gser, ULONG interface_index, ULONG command,
                                    ULONG value, UCHAR *data_buffer, ULONG data_length)
{

    /* Sanity check.  */
    if (gser == UX_NULL)
        return(UX_INVALID_PARAMETER);

    /* Invoke GSER command function.  */
    return(_ux_host_class_gser_command(gser, interface_index,
                                    command, value, data_buffer, data_length));
}