summaryrefslogtreecommitdiff
path: root/common/usbx_device_classes/src/ux_device_class_storage_read_toc.c
blob: 0623a5def6fb8965a7a2692116248497fae159da (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
207
/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   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"


#if UX_SLAVE_CLASS_STORAGE_BUFFER_SIZE < 20
/* #error UX_SLAVE_CLASS_STORAGE_BUFFER_SIZE too small, please check  */
/* Build option checked runtime by UX_ASSERT  */
#endif

/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_device_class_storage_read_toc                   PORTABLE C      */
/*                                                           6.3.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function performs a READ_TOC SCSI command. This is only for    */
/*    supporting CD-ROM emulation and is hardwired to what Windows wants. */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    storage                               Pointer to storage class      */
/*    endpoint_in                           Pointer to IN endpoint        */
/*    endpoint_out                          Pointer to OUT endpoint       */
/*    cbwcb                                 Pointer to CBWCB              */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_device_stack_transfer_request     Transfer request              */
/*    _ux_device_class_storage_csw_send     Send CSW                      */
/*    _ux_utility_memory_set                Set memory                    */
/*    _ux_utility_memory_copy               Copy memory                   */
/*    _ux_utility_short_get_big_endian      Get 16-bit big endian         */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Device Storage Class                                                */
/*                                                                        */
/**************************************************************************/
UINT  _ux_device_class_storage_read_toc(UX_SLAVE_CLASS_STORAGE *storage, ULONG lun,
                                            UX_SLAVE_ENDPOINT *endpoint_in,
                                            UX_SLAVE_ENDPOINT *endpoint_out, UCHAR * cbwcb)
{

UINT                    status;
UX_SLAVE_TRANSFER       *transfer_request;
ULONG                   allocation_length;
ULONG                   toc_length;
UCHAR                   *toc_buffer;


    UX_PARAMETER_NOT_USED(lun);
    UX_PARAMETER_NOT_USED(endpoint_out);

    /* Build option check.  */
    UX_ASSERT(UX_SLAVE_CLASS_STORAGE_BUFFER_SIZE >= 20);

    /* If trace is enabled, insert this event into the trace buffer.  */
    UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_STORAGE_READ_TOC, storage, lun, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)

    /* Obtain the pointer to the transfer request.  */
    transfer_request =  &endpoint_in -> ux_slave_endpoint_transfer_request;

    /* Obtain TOC buffer.  */
    toc_buffer = transfer_request -> ux_slave_transfer_request_data_pointer;

    /* Reset this buffer.  */
    _ux_utility_memory_set(toc_buffer,0,20); /* Use case of memset is verified. */

    /* Get the allocation length.  */
    allocation_length =  _ux_utility_short_get_big_endian(cbwcb + UX_SLAVE_CLASS_STORAGE_READ_TOC_ALLOCATION_LENGTH);

    /* Insert the fist and last tack number.  */
    toc_buffer[2] =  0x01;
    toc_buffer[3] =  0x01;

    /* Set TOC length by default.  */
    toc_length = 20;

    /* Insert the ADR and control values.  */
    toc_buffer[5] =  0x14;

    /* Insert the TOC tack number.  */
    toc_buffer[6] =  0x01;

    /* Check if the request is for the TOC or time stamp.  */
    switch (*(cbwcb + UX_SLAVE_CLASS_STORAGE_READ_TOC_FORMAT))
    {

        case  0x02 :

            /* Set the toc buffer length.  */
            toc_length  = 20;

            /* Insert the TOC buffer length.  */
            toc_buffer[1] =  0x12;

            /* Insert some time values.  */
            toc_buffer[10] =  0x02;
            toc_buffer[13] =  0x17;
            toc_buffer[14] =  0xAA;
            toc_buffer[18] =  0x04;
            toc_buffer[19] =  0x1a;

            break;

        case 0x01 :

            /* Set the toc buffer length.  */
            toc_length  = 19;

            /* Insert the TOC buffer length.  */
            toc_buffer[1] =  0x12;

            toc_buffer[13] =  0x17;
            toc_buffer[14] =  0xAA;
            toc_buffer[19] =  0xb0;

            break;

        case 0x00 :

            /* Set the toc buffer length.  */
            toc_length  = 20;

            /* Insert the TOC buffer length.  */
            toc_buffer[1] =  0x12;

            /* Insert some time values.  */
            toc_buffer[10] =  0x02;
            toc_buffer[13] =  0x17;
            toc_buffer[14] =  0xAA;
            toc_buffer[18] =  0x04;
            toc_buffer[19] =  0x1a;

            break;
    }

    /* Check how much we can send back.  */
    if (allocation_length > toc_length)

        /* We return less than demanded.  */
        allocation_length = toc_length;

#if defined(UX_DEVICE_STANDALONE)

    /* Next: Transfer (DATA).  */
    storage -> ux_device_class_storage_state = UX_DEVICE_CLASS_STORAGE_STATE_TRANS_START;
    storage -> ux_device_class_storage_cmd_state = UX_DEVICE_CLASS_STORAGE_CMD_READ;

    storage -> ux_device_class_storage_transfer = transfer_request;
    storage -> ux_device_class_storage_device_length = allocation_length;
    storage -> ux_device_class_storage_data_length = allocation_length;
    storage -> ux_device_class_storage_data_count = 0;

#else

    /* Send a data payload with the TOC response buffer.  */
    _ux_device_stack_transfer_request(transfer_request, allocation_length, allocation_length);
#endif

    /* Now we set the CSW with success.  */
    storage -> ux_slave_class_storage_csw_status = UX_SLAVE_CLASS_STORAGE_CSW_PASSED;
    status = UX_SUCCESS;

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

}