AM263Px MCU+ SDK  10.01.00
ieee802-dot1ab-lldp_access.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 */
50 #ifndef IEEE802_DOT1AB_LLDP_ACCESS_H_
51 #define IEEE802_DOT1AB_LLDP_ACCESS_H_
52 #include "yang_db_access.h"
53 
54 typedef struct
55 {
56  kvs_t vk;
57  uint8_t vk_sz;
59 
60 int ydbi_get_item_abk1vk0(yang_db_item_access_t *ydbia, void **rval, uint8_t k1, bool status);
61 
62 int ydbi_get_item_abk2vk0(yang_db_item_access_t *ydbia, void **rval, uint8_t k1, uint8_t k2, bool status);
63 
64 int ydbi_set_item_abk1vk0(yang_db_item_access_t *ydbia, void *rval, uint32_t vsize, uint8_t k1, bool status, uint8_t notice);
65 
66 int ydbi_set_item_abk2vk0(yang_db_item_access_t *ydbia, void *rval, uint32_t vsize, uint8_t k1, uint8_t k2, bool status, uint8_t notice);
67 
72 int ydbi_get_item_abknvkn(yang_db_item_access_t *ydbia,
73  void **rval,
74  uint8_t kn[],
75  uint8_t kn_sz,
76  attribute_pair_t attrs[],
77  uint8_t kvs_sz,
78  bool status);
79 
84 int ydbi_set_item_abknvkn(yang_db_item_access_t *ydbia,
85  uint8_t kn[],
86  uint8_t kn_sz,
87  attribute_pair_t attrs[],
88  uint8_t kvs_sz,
89  bool status,
90  void* value,
91  uint32_t vsize,
92  uint8_t notice);
93 
98 int ydbi_del_item_abknvkn(yang_db_item_access_t *ydbia,
99  uint8_t kn[],
100  uint8_t kn_sz,
101  attribute_pair_t attrs[],
102  uint8_t kvs_sz,
103  bool status,
104  uint8_t notice);
105 
106 #endif /* IEEE802_DOT1AB_LLDP_ACCESS_H_ */
attribute_pair_t
Definition: ieee802-dot1ab-lldp_access.h:55
ydbi_get_item_abknvkn
int ydbi_get_item_abknvkn(yang_db_item_access_t *ydbia, void **rval, uint8_t kn[], uint8_t kn_sz, attribute_pair_t attrs[], uint8_t kvs_sz, bool status)
Get val base on n key from LLDP until end Also provided vkn as attribute.
ydbi_set_item_abk2vk0
int ydbi_set_item_abk2vk0(yang_db_item_access_t *ydbia, void *rval, uint32_t vsize, uint8_t k1, uint8_t k2, bool status, uint8_t notice)
attribute_pair_t::vk
kvs_t vk
Definition: ieee802-dot1ab-lldp_access.h:56
attribute_pair_t::vk_sz
uint8_t vk_sz
size of kv
Definition: ieee802-dot1ab-lldp_access.h:57
ydbi_get_item_abk2vk0
int ydbi_get_item_abk2vk0(yang_db_item_access_t *ydbia, void **rval, uint8_t k1, uint8_t k2, bool status)
ydbi_set_item_abknvkn
int ydbi_set_item_abknvkn(yang_db_item_access_t *ydbia, uint8_t kn[], uint8_t kn_sz, attribute_pair_t attrs[], uint8_t kvs_sz, bool status, void *value, uint32_t vsize, uint8_t notice)
Set val base on n key from LLDP until end Also provided vkn as attribute.
ydbi_get_item_abk1vk0
int ydbi_get_item_abk1vk0(yang_db_item_access_t *ydbia, void **rval, uint8_t k1, bool status)
ydbi_del_item_abknvkn
int ydbi_del_item_abknvkn(yang_db_item_access_t *ydbia, uint8_t kn[], uint8_t kn_sz, attribute_pair_t attrs[], uint8_t kvs_sz, bool status, uint8_t notice)
Set val base on n key from LLDP until end Also provided vkn as attribute.
ydbi_set_item_abk1vk0
int ydbi_set_item_abk1vk0(yang_db_item_access_t *ydbia, void *rval, uint32_t vsize, uint8_t k1, bool status, uint8_t notice)