common/core/src/ux_host_stack_device_configuration_deactivate.c (usbx)

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

/**************************************************************************/ /* */ /* Copyright (c) Microsoft Corporation. All rights reserved. */ /* */ /* This software is licensed under the Microsoft Software License */ /* Terms for Microsoft Azure RTOS. Full text of the license can be */ /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */ /* and in the root directory of this software. */ /* */ /**************************************************************************/ /**************************************************************************/ /**************************************************************************/ /** */ /** 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_device_configuration_deactivate PORTABLE C */ /* 6.1.10 */ /* AUTHOR */ /* */ /* Chaoqiong Xiao, Microsoft Corporation */ /* */ /* DESCRIPTION */ /* */ /* This function deactivate current configuration for a device. */ /* When this configuration is deactivated, all the device interfaces */ /* are deactivated on the device. */ /* */ /* INPUT */ /* */ /* */ /* OUTPUT */ /* */ /* Completion Status */ /* */ /* CALLS */ /* */ /* _ux_utility_semaphore_get Get semaphore */ /* _ux_utility_semaphore_put Put semaphore */ /* (ux_host_class_entry_function) Class entry function */ /* */ /* CALLED BY */ /* */ /* Application */ /* USBX Components */ /* */ /* RELEASE HISTORY */ /* */ /* DATE NAME DESCRIPTION */ /* */ /* 02-02-2021 Chaoqiong Xiao Initial Version 6.1.4 */ /* 06-02-2021 Chaoqiong Xiao Modified comment(s), */ /* fixed trace enabled error, */ /* resulting in version 6.1.7 */ /* 01-31-2022 Chaoqiong Xiao Modified comment(s), */ /* added standalone support, */ /* resulting in version 6.1.10 */ /* */ /**************************************************************************/ UINT _ux_host_stack_device_configuration_deactivate(UX_DEVICE *device) { #if defined(UX_HOST_STANDALONE) UX_INTERRUPT_SAVE_AREA #endif UX_HOST_CLASS_COMMAND command; UX_CONFIGURATION *configuration; UX_INTERFACE *interface; UINT status; /* Do a sanity check on the device handle. */ if (device -> ux_device_handle != (ULONG) (ALIGN_TYPE) device) { /* Error trap. */ _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_ENUMERATOR, UX_DEVICE_HANDLE_UNKNOWN); /* If trace is enabled, insert this event into the trace buffer. */ UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_DEVICE_HANDLE_UNKNOWN, device, 0, 0, UX_TRACE_ERRORS, 0, 0) return(UX_DEVICE_HANDLE_UNKNOWN); } /* Get the configuration. */ configuration = device -> ux_device_current_configuration; /* If trace is enabled, insert this event into the trace buffer. */ UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_STACK_DEVICE_CONFIGURATION_DEACTIVATE, device, configuration, 0, 0, UX_TRACE_HOST_STACK_EVENTS, 0, 0) #if defined(UX_HOST_STANDALONE) /* Check device lock. */ UX_DISABLE if (device -> ux_device_flags & UX_DEVICE_FLAG_LOCK) { UX_RESTORE return(UX_BUSY); } device -> ux_device_flags |= UX_DEVICE_FLAG_LOCK; UX_RESTORE #else /* Protect the control endpoint semaphore here. It will be unprotected in the transfer request function. */ status = _ux_host_semaphore_get(&device -> ux_device_protection_semaphore, UX_WAIT_FOREVER); /* Check for status. */ if (status != UX_SUCCESS) { /* Error trap. */ _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_ENUMERATOR, UX_SEMAPHORE_ERROR); /* If trace is enabled, insert this event into the trace buffer. */ UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_SEMAPHORE_ERROR, configuration, 0, 0, UX_TRACE_ERRORS, 0, 0) return(UX_SEMAPHORE_ERROR); } #endif /* Check for the state of the device, if not configured, we are done. */ if (device -> ux_device_state != UX_DEVICE_CONFIGURED) { #if defined(UX_HOST_STANDALONE) device -> ux_device_flags &= ~UX_DEVICE_FLAG_LOCK; #else _ux_host_semaphore_put(&device -> ux_device_protection_semaphore); #endif return(UX_SUCCESS); } /* Deactivate classes by command. */ command.ux_host_class_command_request = UX_HOST_CLASS_COMMAND_DEACTIVATE; /* Search for the active configuration. */ configuration = device -> ux_device_current_configuration; /* If device configured configuration must be activated. */ /* We have the correct configuration, search the interface(s). */ interface = configuration -> ux_configuration_first_interface; /* Loop to perform the search. */ while (interface != UX_NULL) { /* Check if an instance of the interface is present. */ if (interface -> ux_interface_class_instance != UX_NULL) { /* We need to stop the class instance for the device. */ command.ux_host_class_command_instance = interface -> ux_interface_class_instance; /* Call the class. */ interface -> ux_interface_class -> ux_host_class_entry_function(&command); } /* Move to next interface. */ interface = interface -> ux_interface_next_interface; } /* The device can now be un-configured. */ status = _ux_host_stack_device_configuration_reset(device); #if defined(UX_HOST_STANDALONE) device -> ux_device_flags &= ~UX_DEVICE_FLAG_LOCK; #endif /* Return completion status. */ return(status); }