Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	usbx_device_classes/src/ux_device_class_storage_control_request.c	Lines:	36	36	100.0 %
Date:	2024-12-12 17:16:36	Branches:	11	11	100.0 %


/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 *
 * 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                                                        */
/**                                                                       */
/**   Device Storage Class                                                */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define UX_SOURCE_CODE


/* Include necessary system files.  */

#include "ux_api.h"
#include "ux_device_class_storage.h"
#include "ux_device_stack.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_device_class_storage_control_request            PORTABLE C      */
/*                                                           6.1.12       */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function manages the based sent by the host on the control     */
/*    endpoints with a CLASS or VENDOR SPECIFIC type.                     */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    storage                               Pointer to storage class      */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_device_stack_transfer_request     Transfer request              */
/*    _ux_device_stack_transfer_abort       Abort Transfer                */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Device Storage Class                                                */
/*                                                                        */
/*  RELEASE HISTORY                                                       */
/*                                                                        */
/*    DATE              NAME                      DESCRIPTION             */
/*                                                                        */
/*  05-19-2020     Chaoqiong Xiao           Initial Version 6.0           */
/*  09-30-2020     Chaoqiong Xiao           Modified comment(s),          */
/*                                            optimized command logic,    */
/*                                            resulting in version 6.1    */
/*  12-31-2020     Chaoqiong Xiao           Modified comment(s),          */
/*                                            fixed USB CV test issues,   */
/*                                            resulting in version 6.1.3  */
/*  01-31-2022     Chaoqiong Xiao           Modified comment(s),          */
/*                                            added standalone support,   */
/*                                            resulting in version 6.1.10 */
/*  07-29-2022     Chaoqiong Xiao           Modified comment(s),          */
/*                                            fixed parameter/variable    */
/*                                            names conflict C++ keyword, */
/*                                            resulting in version 6.1.12 */
/*                                                                        */
/**************************************************************************/
UINT  _ux_device_class_storage_control_request(UX_SLAVE_CLASS_COMMAND *command)
{

UX_SLAVE_TRANSFER           *transfer_request;
UX_SLAVE_DEVICE             *device;
UX_SLAVE_CLASS              *class_ptr;
ULONG                       request;
ULONG                       request_value;
ULONG                       request_length;
UX_SLAVE_CLASS_STORAGE      *storage;
#if !defined(UX_DEVICE_STANDALONE)
UX_SLAVE_INTERFACE          *interface_ptr;
#endif
UX_SLAVE_ENDPOINT           *endpoint_in;
UX_SLAVE_ENDPOINT           *endpoint_out;


    /* Get the pointer to the device.  */
    device =  &_ux_system_slave -> ux_system_slave_device;

    /* Get the pointer to the transfer request associated with the control endpoint.  */
    transfer_request =  &device -> ux_slave_device_control_endpoint.ux_slave_endpoint_transfer_request;

    /* Extract the request type from the SETUP packet..   */
    request =  *(transfer_request -> ux_slave_transfer_request_setup + UX_SETUP_REQUEST);
    request_value = _ux_utility_short_get(transfer_request -> ux_slave_transfer_request_setup + UX_SETUP_VALUE);
    request_length = _ux_utility_short_get(transfer_request -> ux_slave_transfer_request_setup + UX_SETUP_LENGTH);

    /* Check if wValue is valid.  */
    if (request_value != 0)
        return(UX_ERROR);

    /* Get the class container.  */
    class_ptr =  command -> ux_slave_class_command_class_ptr;

    /* Get the storage instance from this class container.  */
    storage =  (UX_SLAVE_CLASS_STORAGE *) class_ptr -> ux_slave_class_instance;

    /* Here we proceed only the standard request we know of at the device level.  */
    switch (request)
    {

    case UX_SLAVE_CLASS_STORAGE_RESET:

        /* Check if wLength is valid.  */
        if (request_length != 0)
            return(UX_ERROR);

#if defined(UX_DEVICE_STANDALONE)
        endpoint_in = storage -> ux_device_class_storage_ep_in;
        endpoint_out = storage -> ux_device_class_storage_ep_out;
#else

        /* We need the interface to the class.  */
        interface_ptr =  storage -> ux_slave_class_storage_interface;

        /* Locate the endpoints.  */
        endpoint_in =  interface_ptr -> ux_slave_interface_first_endpoint;

        /* Check the endpoint direction, if IN we have the correct endpoint.  */
        if ((endpoint_in -> ux_slave_endpoint_descriptor.bEndpointAddress & UX_ENDPOINT_DIRECTION) != UX_ENDPOINT_IN)
        {

            /* Wrong direction, we found the OUT endpoint first.  */
            endpoint_out =  endpoint_in;

            /* So the next endpoint has to be the IN endpoint.  */
            endpoint_in =  endpoint_out -> ux_slave_endpoint_next_endpoint;
        }
        else
        {

            /* We found the endpoint IN first, so next endpoint is OUT.  */
            endpoint_out =  endpoint_in -> ux_slave_endpoint_next_endpoint;
        }
#endif

        /* First cancel any transfer on the endpoint OUT, from the host.  */
        transfer_request =  &endpoint_out -> ux_slave_endpoint_transfer_request;
        _ux_device_stack_transfer_abort(transfer_request, UX_TRANSFER_APPLICATION_RESET);

        /* Then cancel any transfer on the endpoint IN, from the host.  */
        transfer_request =  &endpoint_in -> ux_slave_endpoint_transfer_request;
        _ux_device_stack_transfer_abort(transfer_request, UX_TRANSFER_APPLICATION_RESET);

        /* Reset phase error.  */
        storage -> ux_slave_class_storage_csw_status = UX_SLAVE_CLASS_STORAGE_CSW_PASSED;

        break;

    case UX_SLAVE_CLASS_STORAGE_GET_MAX_LUN:

        /* Check if wLength is valid.  */
        if (request_length < 1)
            return(UX_ERROR);

        /* Set the value of the number of LUN in the buffer. The max number of LUN is the
           number of declared LUN - 1.  */
        *transfer_request -> ux_slave_transfer_request_data_pointer =  (UCHAR)(storage -> ux_slave_class_storage_number_lun -1);

        /* Set the phase of the transfer to data out.  */
        transfer_request -> ux_slave_transfer_request_phase =  UX_TRANSFER_PHASE_DATA_OUT;

        /* We can return the LUN number.  */
        _ux_device_stack_transfer_request(transfer_request, 1, 1);
        break;

    default:

        /* Unknown function. It's not handled.  */
        return(UX_ERROR);
    }

    /* It's handled.  */
    return(UX_SUCCESS);
}


Generated by: GCOVR (Version 4.1)

Line	Branch	Exec	Source
1			/***************************************************************************
2			* Copyright (c) 2024 Microsoft Corporation
3			*
4			* This program and the accompanying materials are made available under the
5			* terms of the MIT License which is available at
6			* https://opensource.org/licenses/MIT.
7			*
8			* SPDX-License-Identifier: MIT
9			**************************************************************************/
10
11
12			/**************************************************************************/
13			/**************************************************************************/
14			/** */
15			/** USBX Component */
16			/** */
17			/** Device Storage Class */
18			/** */
19			/**************************************************************************/
20			/**************************************************************************/
21
22			#define UX_SOURCE_CODE
23
24
25			/* Include necessary system files. */
26
27			#include "ux_api.h"
28			#include "ux_device_class_storage.h"
29			#include "ux_device_stack.h"
30
31
32			/**************************************************************************/
33			/* */
34			/* FUNCTION RELEASE */
35			/* */
36			/* _ux_device_class_storage_control_request PORTABLE C */
37			/* 6.1.12 */
38			/* AUTHOR */
39			/* */
40			/* Chaoqiong Xiao, Microsoft Corporation */
41			/* */
42			/* DESCRIPTION */
43			/* */
44			/* This function manages the based sent by the host on the control */
45			/* endpoints with a CLASS or VENDOR SPECIFIC type. */
46			/* */
47			/* INPUT */
48			/* */
49			/* storage Pointer to storage class */
50			/* */
51			/* OUTPUT */
52			/* */
53			/* None */
54			/* */
55			/* CALLS */
56			/* */
57			/* _ux_device_stack_transfer_request Transfer request */
58			/* _ux_device_stack_transfer_abort Abort Transfer */
59			/* */
60			/* CALLED BY */
61			/* */
62			/* Device Storage Class */
63			/* */
64			/* RELEASE HISTORY */
65			/* */
66			/* DATE NAME DESCRIPTION */
67			/* */
68			/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
69			/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
70			/* optimized command logic, */
71			/* resulting in version 6.1 */
72			/* 12-31-2020 Chaoqiong Xiao Modified comment(s), */
73			/* fixed USB CV test issues, */
74			/* resulting in version 6.1.3 */
75			/* 01-31-2022 Chaoqiong Xiao Modified comment(s), */
76			/* added standalone support, */
77			/* resulting in version 6.1.10 */
78			/* 07-29-2022 Chaoqiong Xiao Modified comment(s), */
79			/* fixed parameter/variable */
80			/* names conflict C++ keyword, */
81			/* resulting in version 6.1.12 */
82			/* */
83			/**************************************************************************/
84		406	UINT _ux_device_class_storage_control_request(UX_SLAVE_CLASS_COMMAND *command)
85			{
86
87			UX_SLAVE_TRANSFER *transfer_request;
88			UX_SLAVE_DEVICE *device;
89			UX_SLAVE_CLASS *class_ptr;
90			ULONG request;
91			ULONG request_value;
92			ULONG request_length;
93			UX_SLAVE_CLASS_STORAGE *storage;
94			#if !defined(UX_DEVICE_STANDALONE)
95			UX_SLAVE_INTERFACE *interface_ptr;
96			#endif
97			UX_SLAVE_ENDPOINT *endpoint_in;
98			UX_SLAVE_ENDPOINT *endpoint_out;
99
100
101			/* Get the pointer to the device. */
102		406	device = &_ux_system_slave -> ux_system_slave_device;
103
104			/* Get the pointer to the transfer request associated with the control endpoint. */
105		406	transfer_request = &device -> ux_slave_device_control_endpoint.ux_slave_endpoint_transfer_request;
106
107			/* Extract the request type from the SETUP packet.. */
108		406	request = *(transfer_request -> ux_slave_transfer_request_setup + UX_SETUP_REQUEST);
109		406	request_value = _ux_utility_short_get(transfer_request -> ux_slave_transfer_request_setup + UX_SETUP_VALUE);
110		406	request_length = _ux_utility_short_get(transfer_request -> ux_slave_transfer_request_setup + UX_SETUP_LENGTH);
111
112			/* Check if wValue is valid. */
113	✓✓	406	if (request_value != 0)
114		2	return(UX_ERROR);
115
116			/* Get the class container. */
117		404	class_ptr = command -> ux_slave_class_command_class_ptr;
118
119			/* Get the storage instance from this class container. */
120		404	storage = (UX_SLAVE_CLASS_STORAGE *) class_ptr -> ux_slave_class_instance;
121
122			/* Here we proceed only the standard request we know of at the device level. */
123	✓✓✓	404	switch (request)
124			{
125
126		278	case UX_SLAVE_CLASS_STORAGE_RESET:
127
128			/* Check if wLength is valid. */
129	✓✓	278	if (request_length != 0)
130		1	return(UX_ERROR);
131
132			#if defined(UX_DEVICE_STANDALONE)
133			endpoint_in = storage -> ux_device_class_storage_ep_in;
134			endpoint_out = storage -> ux_device_class_storage_ep_out;
135			#else
136
137			/* We need the interface to the class. */
138		277	interface_ptr = storage -> ux_slave_class_storage_interface;
139
140			/* Locate the endpoints. */
141		277	endpoint_in = interface_ptr -> ux_slave_interface_first_endpoint;
142
143			/* Check the endpoint direction, if IN we have the correct endpoint. */
144	✓✓	277	if ((endpoint_in -> ux_slave_endpoint_descriptor.bEndpointAddress & UX_ENDPOINT_DIRECTION) != UX_ENDPOINT_IN)
145			{
146
147			/* Wrong direction, we found the OUT endpoint first. */
148		16	endpoint_out = endpoint_in;
149
150			/* So the next endpoint has to be the IN endpoint. */
151		16	endpoint_in = endpoint_out -> ux_slave_endpoint_next_endpoint;
152			}
153			else
154			{
155
156			/* We found the endpoint IN first, so next endpoint is OUT. */
157		261	endpoint_out = endpoint_in -> ux_slave_endpoint_next_endpoint;
158			}
159			#endif
160
161			/* First cancel any transfer on the endpoint OUT, from the host. */
162		277	transfer_request = &endpoint_out -> ux_slave_endpoint_transfer_request;
163		277	_ux_device_stack_transfer_abort(transfer_request, UX_TRANSFER_APPLICATION_RESET);
164
165			/* Then cancel any transfer on the endpoint IN, from the host. */
166		277	transfer_request = &endpoint_in -> ux_slave_endpoint_transfer_request;
167		277	_ux_device_stack_transfer_abort(transfer_request, UX_TRANSFER_APPLICATION_RESET);
168
169			/* Reset phase error. */
170		277	storage -> ux_slave_class_storage_csw_status = UX_SLAVE_CLASS_STORAGE_CSW_PASSED;
171
172		277	break;
173
174		125	case UX_SLAVE_CLASS_STORAGE_GET_MAX_LUN:
175
176			/* Check if wLength is valid. */
177	✓✓	125	if (request_length < 1)
178		1	return(UX_ERROR);
179
180			/* Set the value of the number of LUN in the buffer. The max number of LUN is the
181			number of declared LUN - 1. */
182		124	*transfer_request -> ux_slave_transfer_request_data_pointer = (UCHAR)(storage -> ux_slave_class_storage_number_lun -1);
183
184			/* Set the phase of the transfer to data out. */
185		124	transfer_request -> ux_slave_transfer_request_phase = UX_TRANSFER_PHASE_DATA_OUT;
186
187			/* We can return the LUN number. */
188		124	_ux_device_stack_transfer_request(transfer_request, 1, 1);
189		124	break;
190
191		1	default:
192
193			/* Unknown function. It's not handled. */
194		1	return(UX_ERROR);
195			}
196
197			/* It's handled. */
198		401	return(UX_SUCCESS);
199			}