summaryrefslogtreecommitdiff
path: root/common/core/src/ux_host_stack_class_instance_verify.c
blob: 61728179bf74c33cca0fecc9adcd73226694de51 (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
/***************************************************************************
 * 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                                                        */
/**                                                                       */
/**   Host Stack                                                          */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/


/* Include necessary system files.  */

#define UX_SOURCE_CODE

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


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _ux_host_stack_class_instance_verify                PORTABLE C      */
/*                                                           6.1          */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Chaoqiong Xiao, Microsoft Corporation                               */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function ensures that a given instance exists. An application  */
/*    is not responsible for keeping the instance valid pointer. The      */
/*    class is responsible for the instance checks if the instance is     */
/*    still valid.                                                        */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    class_name                            Name of class                 */
/*    class_instance                        Pointer to class instance     */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    Completion Status                                                   */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    _ux_utility_string_length_check       Check C string and return its */
/*                                          length if null-terminated     */
/*    _ux_utility_memory_compare            Compare blocks of memory      */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    USBX Components                                                     */
/*                                                                        */
/**************************************************************************/
UINT  _ux_host_stack_class_instance_verify(UCHAR *class_name, VOID *class_instance)
{

UX_HOST_CLASS   *class_inst;
#if UX_MAX_CLASS_DRIVER > 1
ULONG           class_index;
#endif
VOID            **current_class_instance;
#if !defined(UX_NAME_REFERENCED_BY_POINTER)
UINT            status;
UINT            class_name_length =  0;
#endif

#if !defined(UX_NAME_REFERENCED_BY_POINTER)
    /* Get the length of the class name (exclude null-terminator).  */
    status =  _ux_utility_string_length_check(class_name, &class_name_length, UX_MAX_CLASS_NAME_LENGTH);
    if (status)
        return(status);
#endif

    /* Get first class.  */
    class_inst =  _ux_system_host -> ux_system_host_class_array;

#if UX_MAX_CLASS_DRIVER > 1
    /* We need to parse the class table.  */
    for(class_index = 0; class_index < _ux_system_host -> ux_system_host_max_class; class_index++)
    {
#endif

        /* Check if this class is already used.  */
        if (class_inst -> ux_host_class_status == UX_USED)
        {

            /* Start with the first class instance attached to the class container.  */
            current_class_instance =  class_inst -> ux_host_class_first_instance;

            /* Traverse the list of the class instances until we find the correct instance.  */
            while (current_class_instance != UX_NULL)
            {

                /* Check the class instance attached to the container with the caller's
                   instance.  */
                if (current_class_instance == class_instance)
                {

                    /* We have found the class container. Check if this is the one we need (compare including null-terminator).  */
                    if (ux_utility_name_match(class_inst-> ux_host_class_name, class_name, class_name_length + 1))
                        return(UX_SUCCESS);
                }

                /* Points to the next class instance.  */
                current_class_instance =  *current_class_instance;
            }
        }
#if UX_MAX_CLASS_DRIVER > 1

        /* Move to the next class.  */
        class_inst ++;
    }
#endif

    /* If trace is enabled, insert this event into the trace buffer.  */
    UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_INSTANCE_UNKNOWN, class_instance, 0, 0, UX_TRACE_ERRORS, 0, 0)

    /* This class does not exist.  */
    return(UX_HOST_CLASS_INSTANCE_UNKNOWN);
}