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
|
/***************************************************************************
* 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_session_open PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function opens a session with the PIMA device. The session */
/* is maintained in this state until the session is closed or the */
/* device is unmounted. */
/* */
/* INPUT */
/* */
/* pima Pointer to pima class */
/* pima_session Pointer to pima session */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_pima_command Pima command function */
/* */
/* CALLED BY */
/* */
/* USB application */
/* */
/**************************************************************************/
UINT _ux_host_class_pima_session_open(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session)
{
UX_HOST_CLASS_PIMA_COMMAND command;
ULONG status;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_PIMA_SESSION_OPEN, pima, pima_session, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* Check if there is already a session opened. */
if (pima -> ux_host_class_pima_session != UX_NULL)
return (UX_HOST_CLASS_PIMA_RC_SESSION_ALREADY_OPENED);
/* The transaction ID in the PIMA instance should be reset. */
pima -> ux_host_class_pima_transaction_id = 0;
/* Issue command to open the session with the PIMA device. First set the number of parameters. */
command.ux_host_class_pima_command_nb_parameters = 1;
/* Then set the command to OPEN_SESSION. */
command.ux_host_class_pima_command_operation_code = UX_HOST_CLASS_PIMA_OC_OPEN_SESSION;
/* The session ID is the handle to the session. */
command.ux_host_class_pima_command_parameter_1 = (ULONG) (ALIGN_TYPE) pima_session;
/* Other parameters unused. */
command.ux_host_class_pima_command_parameter_2 = 0;
command.ux_host_class_pima_command_parameter_3 = 0;
command.ux_host_class_pima_command_parameter_4 = 0;
command.ux_host_class_pima_command_parameter_5 = 0;
/* Issue the command. */
status = _ux_host_class_pima_command(pima, &command, 0 , UX_NULL, 0, 0);
/* Check the result. If OK, the session was opened properly. */
if (status == UX_SUCCESS)
{
/* Store the session pointer in the PIMA instance. The PIMA class instance
only supports one opened session at a time at this stage. */
pima -> ux_host_class_pima_session = pima_session;
/* Save the session ID in the session container. This is not too useful since
the session ID is the session structure address. */
pima_session -> ux_host_class_pima_session_id = (ALIGN_TYPE) pima_session;
/* Put the magic number in the session instance. */
pima_session -> ux_host_class_pima_session_magic = UX_HOST_CLASS_PIMA_MAGIC_NUMBER;
/* Mark the session as opened. */
pima_session -> ux_host_class_pima_session_state = UX_HOST_CLASS_PIMA_SESSION_STATE_OPENED;
}
/* Return completion status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _uxe_host_class_pima_session_open PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Yajun Xia, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in pima session open function call. */
/* */
/* INPUT */
/* */
/* pima Pointer to pima class */
/* pima_session Pointer to pima session */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_pima_session_open Open pima session */
/* */
/* CALLED BY */
/* */
/* USB application */
/* */
/**************************************************************************/
UINT _uxe_host_class_pima_session_open(UX_HOST_CLASS_PIMA *pima, UX_HOST_CLASS_PIMA_SESSION *pima_session)
{
/* Sanity checks. */
if ((pima == UX_NULL) || (pima_session == UX_NULL))
return(UX_INVALID_PARAMETER);
/* Call the actual pima session open function. */
return(_ux_host_class_pima_session_open(pima, pima_session));
}
|
