1 /************************************************************************
2 Copyright (c) 2015, The Linux Foundation. All rights reserved.
3 
4 Redistribution and use in source and binary forms, with or without
5 modification, are permitted provided that the following conditions are
6 met:
7     * Redistributions of source code must retain the above copyright
8       notice, this list of conditions and the following disclaimer.
9     * Redistributions in binary form must reproduce the above
10       copyright notice, this list of conditions and the following
11       disclaimer in the documentation and/or other materials provided
12       with the distribution.
13     * Neither the name of The Linux Foundation nor the names of its
14       contributors may be used to endorse or promote products derived
15       from this software without specific prior written permission.
16 
17 THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED
18 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT
20 ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
21 BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
22 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
24 BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
26 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27 IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 ************************************************************************/
29 
30 /**
31  * @file datatop_linked_list.h
32  * @brief Defines linked list struct and declares linked list methods.
33  *
34  * Defines linked list struct which can be used for any data
35  * storage. Declares methods held within datatop_linked_list.c.
36  */
37 
38 #ifndef DATATOP_LINKED_LIST_H
39 #define DATATOP_LINKED_LIST_H
40 
41 /**
42  * @struct dtop_linked_list
43  * @brief Struct used to represent linked list node that stores a pointer with any type.
44  *
45  * @var dtop_linked_list::next_ptr
46  * Pointer to next node in the list.
47  * @var dtop_linked_list::data
48  * Pointer to data the node stores.
49  */
50 struct dtop_linked_list {
51 	struct dtop_linked_list *next_ptr;
52 	void *data;
53 };
54 
55 struct dtop_linked_list *dtop_add_linked_list(void *data,
56 				struct dtop_linked_list *list);
57 void dtop_rem_linked_list(struct dtop_linked_list *head_ptr);
58 #endif /* DATATOP_LINKED_LIST_H */
59 
60