common/core/src/ux_utility_descriptor_pack.c


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

/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   Utility                                                             */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/


/* Include necessary system files.  */

#define UX_SOURCE_CODE

#include "ux_api.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_utility_descriptor_pack                         PORTABLE C      */
/*                                                           6.3.0        */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function will pack an application structure into a USB         */
/*    descriptor.                                                         */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    descriptor                            Pointer to the unpacked       */
/*                                            descriptor                  */
/*    descriptor_structure                  Components of the descriptor  */
/*    descriptor_entries                    Number of entries in the      */
/*                                            descriptor                  */
/*    raw_descriptor                        Pointer to packed descriptor  */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    None                                                                */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_utility_long_put                  Put 32-bit value              */
/*    _ux_utility_short_put                 Put 16-bit value              */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    USBX Components                                                     */
/*                                                                        */
/**************************************************************************/
VOID  _ux_utility_descriptor_pack(UCHAR * descriptor, UCHAR * descriptor_structure,
                        UINT descriptor_entries, UCHAR * raw_descriptor)
{

    /* Loop on all the entries in this descriptor.  */
    while(descriptor_entries--)
    {

        /* Get the length of that component.  */
        switch(*descriptor_structure++)
        {

        /* Check the size then build the component from the source and
           insert it into the target descriptor.  */
        case 4:

            /* Increase address so it's aligned.  */
            while((ALIGN_TYPE)descriptor & 3u)
                descriptor++;

            /* Put the DW.  */
            _ux_utility_long_put(raw_descriptor, *((ULONG *) descriptor));
            raw_descriptor +=  4;
            descriptor += 4;
            break;

        case 2:

            /* Increase address so it's aligned.  */
            while((ALIGN_TYPE)descriptor & 1u)
                descriptor++;

            /* Put the Word.  */
            _ux_utility_short_put(raw_descriptor, (USHORT)*((USHORT *) descriptor));
            raw_descriptor += 2;
            descriptor += 2;
            break;

        default:

            /* Put the byte.  */
            *raw_descriptor =  (UCHAR) *((UCHAR *) descriptor);
            raw_descriptor++;
            descriptor++;
        }
    }

    /* Return to caller.  */
    return;
}