AM261x MCU+ SDK: unibase_binding.h Source File

| AM261x MCU+ SDK 26.00.00 |

unibase_binding.h
Go to the documentation of this file.
1 /*
2 * Copyright (c) 2023 Texas Instruments Incorporated
3 * Copyright (c) 2023 Excelfore Corporation (https://excelfore.com)
4 *
5 * All rights reserved not granted herein.
6 * Limited License.
7 *
8 * Texas Instruments Incorporated grants a world-wide, royalty-free,
9 * non-exclusive license under copyrights and patents it now or hereafter
10 * owns or controls to make, have made, use, import, offer to sell and sell ("Utilize")
11 * this software subject to the terms herein. With respect to the foregoing patent
12 * license, such license is granted solely to the extent that any such patent is necessary
13 * to Utilize the software alone. The patent license shall not apply to any combinations which
14 * include this software, other than combinations with devices manufactured by or for TI ("TI Devices").
15 * No hardware patent is licensed hereunder.
16 *
17 * Redistributions must preserve existing copyright notices and reproduce this license (including the
18 * above copyright notice and the disclaimer and (if applicable) source code license limitations below)
19 * in the documentation and/or other materials provided with the distribution
20 *
21 * Redistribution and use in binary form, without modification, are permitted provided that the following
22 * conditions are met:
23 *
24 * * No reverse engineering, decompilation, or disassembly of this software is permitted with respect to any
25 * software provided in binary form.
26 * * any redistribution and use are licensed by TI for use only with TI Devices.
27 * * Nothing shall obligate TI to provide you with source code for the software licensed and provided to you in object code.
28 *
29 * If software source code is provided to you, modification and redistribution of the source code are permitted
30 * provided that the following conditions are met:
31 *
32 * * any redistribution and use of the source code, including any resulting derivative works, are licensed by
33 * TI for use only with TI Devices.
34 * * any redistribution and use of any object code compiled from the source code and any resulting derivative
35 * works, are licensed by TI for use only with TI Devices.
36 *
37 * Neither the name of Texas Instruments Incorporated nor the names of its suppliers may be used to endorse or
38 * promote products derived from this software without specific prior written permission.
39 *
40 * DISCLAIMER.
41 *
42 * THIS SOFTWARE IS PROVIDED BY TI AND TI"S LICENSORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
43 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
44 * IN NO EVENT SHALL TI AND TI"S LICENSORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
45 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
46 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
47 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
48 * POSSIBILITY OF SUCH DAMAGE.
49 */
64 #ifndef UNIBASE_BINDING_H_
65 #define UNIBASE_BINDING_H_
66
71 #define UBB_DEFAULT_DEBUG_LOG_MEMORY (64*1024)
72
76 #define UBB_MEMOUT_ENDMARK "---###---"
77
81 #define UBB_DEFAULT_LOG_INITSTR "4,ubase:45"
82
86 #ifndef UBB_GETENV
87 #define UBB_GETENV getenv
88 #endif
89
90 #ifdef __cplusplus
91 extern "C" {
92 #endif
93
103 int ubb_memory_out_init(char *mem, int size);
104
111 int ubb_memory_out_close(void);
112
117 char *ubb_memory_out_buffer(void);
118
125 int ubb_memory_out_lastline(char **str, int *size);
126
135 int ubb_memory_out_alldata(char **rstr, int *size);
136
142 int ubb_memory_file_out(const char *fname);
143
148 void ubb_default_initpara(unibase_init_para_t *init_para);
149
150 typedef uint64_t(*get64ts_t)(void);
155 void ubb_set_gptp_gettime64(get64ts_t func);
156
162 void ubb_unibase_easyinit(void);
163
164 #ifdef __cplusplus
165 }
166 #endif
167
168 #endif
169
unibase_init_para_t
initialization parameters
Definition: unibase.h:151
ubb_memory_out_buffer
char * ubb_memory_out_buffer(void)
return the memory pointer of memory_out
ubb_default_initpara
void ubb_default_initpara(unibase_init_para_t *init_para)
return the default initialization parameters supported in the binding layer
get64ts_t
uint64_t(* get64ts_t)(void)
Definition: unibase_binding.h:150
ubb_memory_out_lastline
int ubb_memory_out_lastline(char **str, int *size)
return the most recent output line in memory_out
ubb_memory_out_alldata
int ubb_memory_out_alldata(char **rstr, int *size)
return the all written line data in the buffer
ubb_memory_out_close
int ubb_memory_out_close(void)
de-initialize memory_out function
ubb_memory_out_init
int ubb_memory_out_init(char *mem, int size)
initialize the internal memory_out function
ubb_memory_file_out
int ubb_memory_file_out(const char *fname)
write the data in memory_out buffer into a file
ubb_set_gptp_gettime64
void ubb_set_gptp_gettime64(get64ts_t func)
set gptptime function for ub_gptp_gettime64
ubb_unibase_easyinit
void ubb_unibase_easyinit(void)
initialize unibase with 'ubb_default_initpara'