xref: /freebsd/sys/dev/bhnd/nvram/bhnd_nvram_plistvar.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /*-
2  * Copyright (c) 2015-2016 Landon Fuller <landon@landonf.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer,
10  *    without modification.
11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13  *    redistribution must be conditioned upon including a substantially
14  *    similar Disclaimer requirement for further binary redistribution.
15  *
16  * NO WARRANTY
17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27  * THE POSSIBILITY OF SUCH DAMAGES.
28  *
29  */
30 
31 #ifndef _BHND_NVRAM_BHND_PLISTVAR_H_
32 #define _BHND_NVRAM_BHND_PLISTVAR_H_
33 
34 #include "bhnd_nvram_plist.h"
35 #include <sys/queue.h>
36 
37 LIST_HEAD(bhnd_nvram_plist_entry_list, bhnd_nvram_plist_entry);
38 
39 typedef struct bhnd_nvram_plist_entry		bhnd_nvram_plist_entry;
40 typedef struct bhnd_nvram_plist_entry_list	bhnd_nvram_plist_entry_list;
41 
42 /**
43  * NVRAM property.
44  */
45 struct bhnd_nvram_prop {
46 	volatile u_int	 refs;	/**< refcount */
47 
48 	char		*name;	/**< property name */
49 	bhnd_nvram_val	*val;	/**< property value */
50 };
51 
52 /**
53  * NVRAM property list entry.
54  */
55 struct bhnd_nvram_plist_entry {
56 	bhnd_nvram_prop	*prop;
57 
58 	TAILQ_ENTRY(bhnd_nvram_plist_entry)	pl_link;
59 	LIST_ENTRY(bhnd_nvram_plist_entry)	pl_hash_link;
60 };
61 
62 /**
63  * NVRAM property list.
64  *
65  * Provides an ordered list of property values.
66  */
67 struct bhnd_nvram_plist {
68 	volatile u_int				refs;		/**< refcount */
69 	TAILQ_HEAD(,bhnd_nvram_plist_entry)	entries;	/**< all properties */
70 	size_t					num_entries;	/**< entry count */
71 	bhnd_nvram_plist_entry_list		names[16];	/**< name-based hash table */
72 };
73 
74 #endif /* _BHND_NVRAM_BHND_PLISTVAR_H_ */
75