1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** ThreadX Component */
17 /** */
18 /** Module */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23 #define TXM_MODULE
24 #include "txm_module.h"
25 #ifndef TXM_TRACE_ENABLE_CALL_NOT_USED
26 /**************************************************************************/
27 /* */
28 /* FUNCTION RELEASE */
29 /* */
30 /* _tx_trace_enable PORTABLE C */
31 /* 6.1.10 */
32 /* AUTHOR */
33 /* */
34 /* Scott Larson, Microsoft Corporation */
35 /* */
36 /* DESCRIPTION */
37 /* */
38 /* This function initializes the ThreadX trace buffer and the */
39 /* associated control variables, enabling it for operation. */
40 /* */
41 /* INPUT */
42 /* */
43 /* trace_buffer_start Start of trace buffer */
44 /* trace_buffer_size Size (bytes) of trace buffer */
45 /* registry_entries Number of object registry */
46 /* entries. */
47 /* */
48 /* OUTPUT */
49 /* */
50 /* Completion Status */
51 /* */
52 /* CALLS */
53 /* */
54 /* _txm_module_kernel_call_dispatcher */
55 /* */
56 /* CALLED BY */
57 /* */
58 /* Module application code */
59 /* */
60 /* RELEASE HISTORY */
61 /* */
62 /* DATE NAME DESCRIPTION */
63 /* */
64 /* 09-30-2020 Scott Larson Initial Version 6.1 */
65 /* 01-31-2022 Scott Larson Modified comments and added */
66 /* CALL_NOT_USED option, */
67 /* resulting in version 6.1.10 */
68 /* */
69 /**************************************************************************/
_tx_trace_enable(VOID * trace_buffer_start,ULONG trace_buffer_size,ULONG registry_entries)70 UINT _tx_trace_enable(VOID *trace_buffer_start, ULONG trace_buffer_size, ULONG registry_entries)
71 {
72
73 UINT return_value;
74
75 /* Call module manager dispatcher. */
76 return_value = (UINT) (_txm_module_kernel_call_dispatcher)(TXM_TRACE_ENABLE_CALL, (ALIGN_TYPE) trace_buffer_start, (ALIGN_TYPE) trace_buffer_size, (ALIGN_TYPE) registry_entries);
77
78 /* Return value to the caller. */
79 return(return_value);
80 }
81 #endif
82