1 /***************************************************************************
2 * Copyright (c) 2024 Microsoft Corporation
3 *
4 * This program and the accompanying materials are made available under the
5 * terms of the MIT License which is available at
6 * https://opensource.org/licenses/MIT.
7 *
8 * SPDX-License-Identifier: MIT
9 **************************************************************************/
10
11
12 /**************************************************************************/
13 /**************************************************************************/
14 /** */
15 /** ThreadX Component */
16 /** */
17 /** Module */
18 /** */
19 /**************************************************************************/
20 /**************************************************************************/
21
22 #define TXM_MODULE
23 #include "txm_module.h"
24 #ifndef TXM_MODULE_OBJECT_POINTER_GET_CALL_NOT_USED
25 /**************************************************************************/
26 /* */
27 /* FUNCTION RELEASE */
28 /* */
29 /* _txm_module_manager_object_pointer_get PORTABLE C */
30 /* 6.1.10 */
31 /* AUTHOR */
32 /* */
33 /* Scott Larson, Microsoft Corporation */
34 /* */
35 /* DESCRIPTION */
36 /* */
37 /* This function is deprecated and calls the secure version of this */
38 /* function (_txm_module_manager_object_pointer_get_extended) with the */
39 /* maximum possible name length since none was passed. */
40 /* */
41 /* INPUT */
42 /* */
43 /* object_type Type of object, as follows: */
44 /* */
45 /* TXM_BLOCK_POOL_OBJECT */
46 /* TXM_BYTE_POOL_OBJECT */
47 /* TXM_EVENT_FLAGS_OBJECT */
48 /* TXM_MUTEX_OBJECT */
49 /* TXM_QUEUE_OBJECT */
50 /* TXM_SEMAPHORE_OBJECT */
51 /* TXM_THREAD_OBJECT */
52 /* TXM_TIMER_OBJECT */
53 /* name Name to search for */
54 /* object_ptr Pointer to the object */
55 /* */
56 /* OUTPUT */
57 /* */
58 /* TX_SUCCESS Successful completion */
59 /* TX_PTR_ERROR Invalid name or object ptr */
60 /* TX_OPTION_ERROR Invalid option type */
61 /* TX_NO_INSTANCE Object not found */
62 /* */
63 /* CALLS */
64 /* */
65 /* _txm_module_kernel_call_dispatcher */
66 /* */
67 /* CALLED BY */
68 /* */
69 /* Module application code */
70 /* */
71 /* RELEASE HISTORY */
72 /* */
73 /* DATE NAME DESCRIPTION */
74 /* */
75 /* 09-30-2020 Scott Larson Initial Version 6.1 */
76 /* 01-31-2022 Scott Larson Modified comments and added */
77 /* CALL_NOT_USED option, */
78 /* resulting in version 6.1.10 */
79 /* */
80 /**************************************************************************/
_txm_module_object_pointer_get(UINT object_type,CHAR * name,VOID ** object_ptr)81 UINT _txm_module_object_pointer_get(UINT object_type, CHAR *name, VOID **object_ptr)
82 {
83
84 UINT return_value;
85
86 /* Call module manager dispatcher. */
87 return_value = (UINT) (_txm_module_kernel_call_dispatcher)(TXM_MODULE_OBJECT_POINTER_GET_CALL, (ALIGN_TYPE) object_type, (ALIGN_TYPE) name, (ALIGN_TYPE) object_ptr);
88
89 /* Return value to the caller. */
90 return(return_value);
91 }
92 #endif
93
