1/*-
2 * Copyright (c) 2020, Ryan Moeller <freqlabs@FreeBSD.org>
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 * SUCH DAMAGE.
24 */
25
26{# THIS IS A TEMPLATE PROCESSED BY lib/libifconfig/sfp.lua #}
27
28#pragma once
29
30#include <stdint.h>
31
32{%
33for _, ent in ipairs(enums) do
34    if type(ent) == "string" then
35%}
36/*
37 * {*ent*}
38 */
39
40{%
41    else
42        local enum = ent
43        local name = "sfp_"..enum.name
44        local num, sym, desc, disp
45%}
46/** {*enum.description*} */
47enum {*name*} {
48{%
49        for _, item in ipairs(enum.values) do
50            val, sym, desc, disp = table.unpack(item)
51            local symbol = string.upper(name).."_"..sym
52%}
53	{*symbol*} = {*val*}, /**< {*desc*} */
54{%
55        end
56%}
57};
58
59/** Get the symbolic name of a given {*name*} value */
60const char *ifconfig_{*name*}_symbol(enum {*name*});
61
62/** Get a brief description of a given {*name*} value */
63const char *ifconfig_{*name*}_description(enum {*name*});
64
65{%
66        if disp then
67%}
68/** Get a shortened user-friendly display name for a given {*name*} value */
69const char *ifconfig_{*name*}_display(enum {*name*});
70
71{%
72        end
73    end
74end
75%}
76/*
77 * Descriptions of each enum
78 */
79
80{%
81for _, ent in ipairs(enums) do
82    if type(ent) == "table" then
83        local enum = ent
84        local name = "sfp_"..enum.name
85%}
86/** Get a brief description of the {*name*} enum */
87static inline const char *
88ifconfig_enum_{*name*}_description(void)
89{
90	return ("{*enum.description*}");
91}
92
93{%
94    end
95end
96%}
97/*
98 * Info struct definitions
99 */
100
101struct ifconfig_sfp_info {
102{%
103for _, ent in ipairs(enums) do
104    if type(ent) == "table" then
105        local enum = ent
106        local name = "sfp_"..enum.name
107        local t = string.format("uint%d_t", enum.bits)
108%}
109	{*t*} {*name*}; /**< {*enum.description*} */
110{%
111    end
112end
113%}
114};
115
116struct ifconfig_sfp_info_strings {
117{%
118for _, ent in ipairs(enums) do
119    if type(ent) == "table" then
120        local enum = ent
121        local name = "sfp_"..enum.name
122%}
123	const char *{*name*}; /**< {*enum.description*} */
124{%
125    end
126end
127%}
128};
129