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_mode_select                PORTABLE C      */
37 /*                                                           6.1.10       */
38 /*  AUTHOR                                                                */
39 /*                                                                        */
40 /*    Chaoqiong Xiao, Microsoft Corporation                               */
41 /*                                                                        */
42 /*  DESCRIPTION                                                           */
43 /*                                                                        */
44 /*    This function performs a MODE_SELECT SCSI command. It is not        */
45 /*    supported in this release.                                          */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    storage                               Pointer to storage class      */
50 /*    endpoint_in                           Pointer to IN endpoint        */
51 /*    endpoint_out                          Pointer to OUT endpoint       */
52 /*    cbwcb                                 Pointer to CBWCB              */
53 /*                                                                        */
54 /*  OUTPUT                                                                */
55 /*                                                                        */
56 /*    Completion Status                                                   */
57 /*                                                                        */
58 /*  CALLS                                                                 */
59 /*                                                                        */
60 /*    _ux_device_stack_endpoint_stall       Stall endpoint                */
61 /*    _ux_device_class_storage_csw_send     Send CSW                      */
62 /*                                                                        */
63 /*  CALLED BY                                                             */
64 /*                                                                        */
65 /*    Device Storage Class                                                */
66 /*                                                                        */
67 /*  RELEASE HISTORY                                                       */
68 /*                                                                        */
69 /*    DATE              NAME                      DESCRIPTION             */
70 /*                                                                        */
71 /*  05-19-2020     Chaoqiong Xiao           Initial Version 6.0           */
72 /*  09-30-2020     Chaoqiong Xiao           Modified comment(s),          */
73 /*                                            optimized command logic,    */
74 /*                                            resulting in version 6.1    */
75 /*  12-31-2020     Chaoqiong Xiao           Modified comment(s),          */
76 /*                                            fixed USB CV test issues,   */
77 /*                                            resulting in version 6.1.3  */
78 /*  01-31-2022     Chaoqiong Xiao           Modified comment(s),          */
79 /*                                            added standalone support,   */
80 /*                                            resulting in version 6.1.10 */
81 /*                                                                        */
82 /**************************************************************************/
_ux_device_class_storage_mode_select(UX_SLAVE_CLASS_STORAGE * storage,ULONG lun,UX_SLAVE_ENDPOINT * endpoint_in,UX_SLAVE_ENDPOINT * endpoint_out,UCHAR * cbwcb)83 UINT  _ux_device_class_storage_mode_select(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun,
84                                             UX_SLAVE_ENDPOINT *endpoint_in,
85                                             UX_SLAVE_ENDPOINT *endpoint_out, UCHAR * cbwcb)
86 {
87 
88     UX_PARAMETER_NOT_USED(endpoint_in);
89     UX_PARAMETER_NOT_USED(cbwcb);
90 
91     /* If trace is enabled, insert this event into the trace buffer.  */
92     UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_STORAGE_MODE_SELECT, storage, lun, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
93 
94     /* This command is not yet supported. So Stall the endpoint.  */
95     if (storage -> ux_slave_class_storage_host_length)
96     {
97 
98 #if !defined(UX_DEVICE_STANDALONE)
99         _ux_device_stack_endpoint_stall(endpoint_out);
100 #else
101         UX_PARAMETER_NOT_USED(endpoint_out);
102 #endif
103 
104         storage -> ux_slave_class_storage_csw_residue = storage -> ux_slave_class_storage_host_length;
105     }
106 
107     /* And update the REQUEST_SENSE codes.  */
108     storage -> ux_slave_class_storage_lun[lun].ux_slave_class_storage_request_sense_status =
109                                             UX_DEVICE_CLASS_STORAGE_SENSE_STATUS(0x05,0x26,0x01);
110 
111     /* Now we set the CSW with failure.  */
112     storage -> ux_slave_class_storage_csw_status = UX_SLAVE_CLASS_STORAGE_CSW_FAILED;
113 
114     /* Error trap. */
115     _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_FUNCTION_NOT_SUPPORTED);
116 
117     /* If trace is enabled, insert this event into the trace buffer.  */
118     UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_FUNCTION_NOT_SUPPORTED, 0, 0, 0, UX_TRACE_ERRORS, 0, 0)
119 
120     /* Return not supported error!  */
121     return(UX_FUNCTION_NOT_SUPPORTED);
122 }
123 
124