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
|
/***************************************************************************
* 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 */
/** */
/** PIMA Class */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_class_pima.h"
#include "ux_host_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_pima_activate PORTABLE C */
/* 6.1.12 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function creates the ACM instance, configure the device ... */
/* */
/* INPUT */
/* */
/* command Pima class command pointer */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_pima_configure Configure pima class */
/* _ux_host_class_pima_endpoints_get Get endpoints of pima */
/* _ux_host_stack_class_instance_create Create class instance */
/* _ux_host_stack_class_instance_destroy Destroy the class instance */
/* _ux_utility_memory_allocate Allocate memory block */
/* _ux_utility_memory_free Free memory block */
/* */
/* CALLED BY */
/* */
/* _ux_host_class_pima_entry Entry of pima class */
/* */
/**************************************************************************/
UINT _ux_host_class_pima_activate(UX_HOST_CLASS_COMMAND *command)
{
UX_INTERFACE *interface_ptr;
UX_HOST_CLASS_PIMA *pima;
UINT status;
/* The PIMA class is always activated by the interface descriptor and not the
device descriptor. */
interface_ptr = (UX_INTERFACE *) command -> ux_host_class_command_container;
/* Obtain memory for this class instance. */
pima = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, sizeof(UX_HOST_CLASS_PIMA));
if (pima == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Allocate some DMA safe memory for sending/receiving headers. */
pima -> ux_host_class_pima_container = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, UX_HOST_CLASS_PIMA_CONTAINER_SIZE);
if (pima -> ux_host_class_pima_container == UX_NULL)
status = UX_MEMORY_INSUFFICIENT;
else
status = UX_SUCCESS;
/* Allocate some DMA safe memory for receiving pima events. */
if (status == UX_SUCCESS)
{
pima -> ux_host_class_pima_event_buffer = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, UX_HOST_CLASS_PIMA_AEI_MAX_LENGTH);
if (pima -> ux_host_class_pima_event_buffer == UX_NULL)
status = UX_MEMORY_INSUFFICIENT;
}
/* Go on if no error. */
if (status == UX_SUCCESS)
{
/* Store the class container into this instance. */
pima -> ux_host_class_pima_class = command -> ux_host_class_command_class_ptr;
/* Store the interface container into the pima class instance. */
pima -> ux_host_class_pima_interface = interface_ptr;
/* Store the device container into the pima class instance. */
pima -> ux_host_class_pima_device = interface_ptr -> ux_interface_configuration -> ux_configuration_device;
/* This instance of the device must also be stored in the interface container. */
interface_ptr -> ux_interface_class_instance = (VOID *) pima;
/* Create this class instance. */
_ux_host_stack_class_instance_create(pima -> ux_host_class_pima_class, (VOID *) pima);
/* Configure the pima. */
status = _ux_host_class_pima_configure(pima);
}
/* Get the pima endpoint(s). We will need to search for Bulk Out, Bulk In and interrupt endpoints. */
if (status == UX_SUCCESS)
status = _ux_host_class_pima_endpoints_get(pima);
/* Success things. */
if (status == UX_SUCCESS)
{
/* Mark the pima as live now. */
pima -> ux_host_class_pima_state = UX_HOST_CLASS_INSTANCE_LIVE;
/* If all is fine and the device is mounted, we may need to inform the application
if a function has been programmed in the system structure. */
if (_ux_system_host -> ux_system_host_change_function != UX_NULL)
{
/* Call system change function. */
_ux_system_host -> ux_system_host_change_function(UX_DEVICE_INSERTION, pima -> ux_host_class_pima_class, (VOID *) pima);
}
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_PIMA_ACTIVATE, pima, 0, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* If trace is enabled, register this object. */
UX_TRACE_OBJECT_REGISTER(UX_TRACE_HOST_OBJECT_TYPE_INTERFACE, pima, 0, 0, 0)
/* Return success. */
return(UX_SUCCESS);
}
/* Free existing resources. */
if (pima -> ux_host_class_pima_event_buffer)
{
_ux_host_stack_class_instance_destroy(pima -> ux_host_class_pima_class, (VOID *) pima);
interface_ptr -> ux_interface_class_instance = UX_NULL;
_ux_utility_memory_free(pima -> ux_host_class_pima_event_buffer);
}
if (pima -> ux_host_class_pima_container)
_ux_utility_memory_free(pima -> ux_host_class_pima_container);
_ux_utility_memory_free(pima);
/* Return completion status. */
return(status);
}
|
