diff --git a/packages/base/any/onlp/src/onlp/doc/.gitignore b/packages/base/any/onlp/src/onlp/doc/.gitignore new file mode 100644 index 00000000..4bec8fe4 --- /dev/null +++ b/packages/base/any/onlp/src/onlp/doc/.gitignore @@ -0,0 +1,2 @@ +*.db +latex diff --git a/packages/base/any/onlp/src/onlp/doc/html/annotated.html b/packages/base/any/onlp/src/onlp/doc/html/annotated.html new file mode 100644 index 00000000..5e15fd9c --- /dev/null +++ b/packages/base/any/onlp/src/onlp/doc/html/annotated.html @@ -0,0 +1,112 @@ + + +
+ + + +|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
| Conlp_asset_info_s | This structure describes general asset information that may be associated with a particular OID |
| Conlp_chassis_info_s | Chassis Information Structure |
| Conlp_config_settings_s | |
| Conlp_fan_info_s | |
| Conlp_generic_info_s | Generic OID Information Structure |
| Conlp_led_info_s | |
| Conlp_module_info_s | Module OID Information Structure |
| Conlp_oid_hdr_s | |
| Conlp_psu_info_t | |
| Conlp_sfp_info_t | |
| Conlp_thermal_info_s |
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/attribute_8h.html b/packages/base/any/onlp/src/onlp/doc/html/attribute_8h.html
new file mode 100644
index 00000000..32f40214
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/attribute_8h.html
@@ -0,0 +1,173 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Attributes. +More...
+#include <onlp/oids.h>#include <onlp/onlp.h>#include <onlp/stdattrs.h>#include <AIM/aim_pvs.h>Go to the source code of this file.
++Macros | |
| +#define | ONLP_ATTRIBUTE_EQUALS(_a, _b) (!strcmp(_a, _b)) |
| Attribute comparitor. | |
+Functions | |
| int | onlp_attribute_sw_init (void) |
| Initialize the attribute subsystem. More... | |
| int | onlp_attribute_hw_init (uint32_t flags) |
| Hardware initialization of the attribute subsystem. More... | |
| int | onlp_attribute_supported (onlp_oid_t oid, const char *attribute) |
| Determine whether the OID supports the given attribute. More... | |
| int | onlp_attribute_set (onlp_oid_t oid, const char *attribute, void *value) |
| Set an attribute on the given OID. More... | |
| int | onlp_attribute_get (onlp_oid_t oid, const char *attribute, void **value) |
| Get an attribute from the given OID. More... | |
| int | onlp_attribute_free (onlp_oid_t oid, const char *attribute, void *value) |
| Free an attribute value returned from onlp_attribute_get(). More... | |
| int | onlp_attribute_onie_info_get (onlp_oid_t oid, onlp_onie_info_t **rp) |
| Request the ONIE attribute. More... | |
| int | onlp_attribute_onie_info_free (onlp_oid_t oid, onlp_onie_info_t *p) |
| Free an ONIE attribute pointer. More... | |
| int | onlp_attribute_onie_info_get_json (onlp_oid_t oid, cJSON **rp) |
| Request the ONIE attribute in JSON. More... | |
| int | onlp_attribute_onie_info_show (onlp_oid_t oid, aim_pvs_t *pvs) |
| Show the ONIE attribute. More... | |
| int | onlp_attribute_onie_info_show_json (onlp_oid_t oid, aim_pvs_t *pvs) |
| Show the ONIE attribute (JSON) More... | |
| int | onlp_attribute_asset_info_get (onlp_oid_t oid, onlp_asset_info_t **rp) |
| Determine if the ONIE attribute is supported. More... | |
| int | onlp_attribute_asset_info_free (onlp_oid_t oid, onlp_asset_info_t *p) |
| Free an asset attribute pointer. More... | |
| int | onlp_attribute_asset_info_get_json (onlp_oid_t oid, cJSON **rp) |
| Request the asset attribute in JSON. More... | |
| int | onlp_attribute_asset_info_show (onlp_oid_t oid, aim_pvs_t *pvs) |
| Show the asset attribute. More... | |
| int | onlp_attribute_asset_info_show_json (onlp_oid_t oid, aim_pvs_t *pvs) |
| Show the asset attribute (JSON). More... | |
Attributes.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/attribute_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/attribute_8h_source.html
new file mode 100644
index 00000000..2d2c26a1
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/attribute_8h_source.html
@@ -0,0 +1,190 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/attributei_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/attributei_8h_source.html
new file mode 100644
index 00000000..dd63f5a1
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/attributei_8h_source.html
@@ -0,0 +1,150 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/base_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/base_8h_source.html
new file mode 100644
index 00000000..65cb99d8
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/base_8h_source.html
@@ -0,0 +1,145 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/bc_s.png b/packages/base/any/onlp/src/onlp/doc/html/bc_s.png
new file mode 100644
index 00000000..224b29aa
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/bc_s.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/bdwn.png b/packages/base/any/onlp/src/onlp/doc/html/bdwn.png
new file mode 100644
index 00000000..940a0b95
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/bdwn.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/chassis_8h.html b/packages/base/any/onlp/src/onlp/doc/html/chassis_8h.html
new file mode 100644
index 00000000..cd8890ac
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/chassis_8h.html
@@ -0,0 +1,170 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Chassis OID Interface. +More...
+#include <onlp/onlp_config.h>#include <onlp/onlp.h>#include <onlplib/onie.h>#include <onlplib/pi.h>#include <onlp/oids.h>Go to the source code of this file.
++Data Structures | |
| struct | onlp_chassis_info_s |
| Chassis Information Structure. More... | |
+Typedefs | |
| +typedef struct onlp_chassis_info_s | onlp_chassis_info_t |
| Chassis Information Structure. | |
+Functions | |
| int | onlp_chassis_sw_init (void) |
| Initialize the chassis software module. More... | |
| int | onlp_chassis_hw_init (uint32_t flags) |
| Initialize the chassis. More... | |
| int | onlp_chassis_sw_denit (void) |
| Deinitialize the chassis software module. More... | |
| int | onlp_chassis_hdr_get (onlp_oid_t oid, onlp_oid_hdr_t *hdr) |
| Get the Chassis Header structure. More... | |
| int | onlp_chassis_info_get (onlp_oid_t oid, onlp_chassis_info_t *info) |
| Get the chassis info structure. More... | |
| int | onlp_chassis_info_to_user_json (onlp_chassis_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a chassis info structure to user JSON. More... | |
| int | onlp_chassis_info_to_json (onlp_chassis_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a chassis info structure to JSON. More... | |
| int | onlp_chassis_info_from_json (cJSON *cj, onlp_chassis_info_t *info) |
| Convert a JSON object to a chassis info structure. More... | |
| int | onlp_chassis_environment_to_json (cJSON **cjp, uint32_t flags) |
| Get the user or full environmental json data. More... | |
| int | onlp_chassis_environment_show (aim_pvs_t *pvs, uint32_t flags) |
| Show the environmental data. More... | |
| int | onlp_chassis_debug_get_json (cJSON **rv) |
| Construct the Chassis debug JSON object. More... | |
| int | onlp_chassis_debug_show (aim_pvs_t *pvs) |
| Show the Chassis debug information. `*. More... | |
Chassis OID Interface.
+The Chassis OID represents the root of the system OID tree. There must be one and only one Chassis OID.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/chassis_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/chassis_8h_source.html
new file mode 100644
index 00000000..ff14a0fb
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/chassis_8h_source.html
@@ -0,0 +1,186 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/chassisi_8h.html b/packages/base/any/onlp/src/onlp/doc/html/chassisi_8h.html
new file mode 100644
index 00000000..d4298620
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/chassisi_8h.html
@@ -0,0 +1,130 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Chassis Platform Interface. +More...
+#include <onlp/chassis.h>Go to the source code of this file.
++Functions | |
| +int | onlp_chassisi_sw_init (void) |
| Software initializaiton of the Chassis module. | |
| int | onlp_chassisi_hw_init (uint32_t flags) |
| Hardware initializaiton of the Chassis module. More... | |
| int | onlp_chassisi_sw_denit (void) |
| Deinitialize the chassis software module. More... | |
| int | onlp_chassisi_hdr_get (onlp_oid_id_t id, onlp_oid_hdr_t *hdr) |
| Get the chassis hdr structure. More... | |
| int | onlp_chassisi_info_get (onlp_oid_id_t id, onlp_chassis_info_t *info) |
| Get the chassis info structure. More... | |
Chassis Platform Interface.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/chassisi_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/chassisi_8h_source.html
new file mode 100644
index 00000000..aef473dd
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/chassisi_8h_source.html
@@ -0,0 +1,146 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/classes.html b/packages/base/any/onlp/src/onlp/doc/html/classes.html
new file mode 100644
index 00000000..67fc4882
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/classes.html
@@ -0,0 +1,106 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/closed.png b/packages/base/any/onlp/src/onlp/doc/html/closed.png
new file mode 100644
index 00000000..98cc2c90
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/closed.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/debug_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/debug_8h_source.html
new file mode 100644
index 00000000..7deab5d0
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/debug_8h_source.html
@@ -0,0 +1,132 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/debugi_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/debugi_8h_source.html
new file mode 100644
index 00000000..8f2cfaef
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/debugi_8h_source.html
@@ -0,0 +1,109 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/dir_72adef417dcbc5bf8193445c31305165.html b/packages/base/any/onlp/src/onlp/doc/html/dir_72adef417dcbc5bf8193445c31305165.html
new file mode 100644
index 00000000..c7611fae
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/dir_72adef417dcbc5bf8193445c31305165.html
@@ -0,0 +1,148 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Directories | |
| directory | platformi |
+Files | |
| file | attribute.h [code] |
| Attributes. | |
| file | chassis.h [code] |
| Chassis OID Interface. | |
| file | debug.h [code] |
| file | fan.h [code] |
| Fan Management. | |
| file | generic.h [code] |
| Generic OID Interface. | |
| file | led.h [code] |
| file | module.h [code] |
| Module OID Interface. | |
| file | oids.h [code] |
| file | onlp.h [code] |
| file | onlp_config.h [code] |
| onlp Configuration Header | |
| file | onlp_dox.h [code] |
| file | onlp_porting.h [code] |
| onlp Porting Macros. | |
| file | platform.h [code] |
| file | psu.h [code] |
| Power Supply Management. | |
| file | sfp.h [code] |
| SFP Management Interface. | |
| file | stdattrs.h [code] |
| Standard OID Attributes. | |
| file | thermal.h [code] |
| Thermal Sensor Management. | |
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/dir_9b91cb305f6dfd5edb8153d5019adc55.html b/packages/base/any/onlp/src/onlp/doc/html/dir_9b91cb305f6dfd5edb8153d5019adc55.html
new file mode 100644
index 00000000..14a5d655
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/dir_9b91cb305f6dfd5edb8153d5019adc55.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Directories | |
| directory | onlp |
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/dir_a7b0466279106ea0b8f86f609f621680.html b/packages/base/any/onlp/src/onlp/doc/html/dir_a7b0466279106ea0b8f86f609f621680.html
new file mode 100644
index 00000000..3c8160f0
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/dir_a7b0466279106ea0b8f86f609f621680.html
@@ -0,0 +1,100 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Directories | |
| directory | inc |
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/dir_ad96458042bbdd0196ba054c40055169.html b/packages/base/any/onlp/src/onlp/doc/html/dir_ad96458042bbdd0196ba054c40055169.html
new file mode 100644
index 00000000..f4ce3c08
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/dir_ad96458042bbdd0196ba054c40055169.html
@@ -0,0 +1,123 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Files | |
| file | attributei.h [code] |
| file | base.h [code] |
| file | chassisi.h [code] |
| Chassis Platform Interface. | |
| file | debugi.h [code] |
| file | fani.h [code] |
| Fan Platform Implementation. | |
| file | ledi.h [code] |
| file | platformi.h [code] |
| file | psui.h [code] |
| Power Supply Management Implementation. | |
| file | sfpi.h [code] |
| SFP Platform Implementation Interface. This interface must be implemented and available for all platforms that support SFP interfaces. | |
| file | thermali.h [code] |
| Thermal Sensor Platform Implementation. | |
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/doxygen.css b/packages/base/any/onlp/src/onlp/doc/html/doxygen.css
new file mode 100644
index 00000000..02e8b015
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/doxygen.css
@@ -0,0 +1,1440 @@
+/* The standard CSS for doxygen 1.8.8 */
+
+body, table, div, p, dl {
+ font: 400 14px/22px Roboto,sans-serif;
+}
+
+/* @group Heading Levels */
+
+h1.groupheader {
+ font-size: 150%;
+}
+
+.title {
+ font: 400 14px/28px Roboto,sans-serif;
+ font-size: 150%;
+ font-weight: bold;
+ margin: 10px 2px;
+}
+
+h2.groupheader {
+ border-bottom: 1px solid #879ECB;
+ color: #354C7B;
+ font-size: 150%;
+ font-weight: normal;
+ margin-top: 1.75em;
+ padding-top: 8px;
+ padding-bottom: 4px;
+ width: 100%;
+}
+
+h3.groupheader {
+ font-size: 100%;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ -webkit-transition: text-shadow 0.5s linear;
+ -moz-transition: text-shadow 0.5s linear;
+ -ms-transition: text-shadow 0.5s linear;
+ -o-transition: text-shadow 0.5s linear;
+ transition: text-shadow 0.5s linear;
+ margin-right: 15px;
+}
+
+h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
+ text-shadow: 0 0 15px cyan;
+}
+
+dt {
+ font-weight: bold;
+}
+
+div.multicol {
+ -moz-column-gap: 1em;
+ -webkit-column-gap: 1em;
+ -moz-column-count: 3;
+ -webkit-column-count: 3;
+}
+
+p.startli, p.startdd {
+ margin-top: 2px;
+}
+
+p.starttd {
+ margin-top: 0px;
+}
+
+p.endli {
+ margin-bottom: 0px;
+}
+
+p.enddd {
+ margin-bottom: 4px;
+}
+
+p.endtd {
+ margin-bottom: 2px;
+}
+
+/* @end */
+
+caption {
+ font-weight: bold;
+}
+
+span.legend {
+ font-size: 70%;
+ text-align: center;
+}
+
+h3.version {
+ font-size: 90%;
+ text-align: center;
+}
+
+div.qindex, div.navtab{
+ background-color: #EBEFF6;
+ border: 1px solid #A3B4D7;
+ text-align: center;
+}
+
+div.qindex, div.navpath {
+ width: 100%;
+ line-height: 140%;
+}
+
+div.navtab {
+ margin-right: 15px;
+}
+
+/* @group Link Styling */
+
+a {
+ color: #3D578C;
+ font-weight: normal;
+ text-decoration: none;
+}
+
+.contents a:visited {
+ color: #4665A2;
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+a.qindex {
+ font-weight: bold;
+}
+
+a.qindexHL {
+ font-weight: bold;
+ background-color: #9CAFD4;
+ color: #ffffff;
+ border: 1px double #869DCA;
+}
+
+.contents a.qindexHL:visited {
+ color: #ffffff;
+}
+
+a.el {
+ font-weight: bold;
+}
+
+a.elRef {
+}
+
+a.code, a.code:visited, a.line, a.line:visited {
+ color: #4665A2;
+}
+
+a.codeRef, a.codeRef:visited, a.lineRef, a.lineRef:visited {
+ color: #4665A2;
+}
+
+/* @end */
+
+dl.el {
+ margin-left: -1cm;
+}
+
+pre.fragment {
+ border: 1px solid #C4CFE5;
+ background-color: #FBFCFD;
+ padding: 4px 6px;
+ margin: 4px 8px 4px 2px;
+ overflow: auto;
+ word-wrap: break-word;
+ font-size: 9pt;
+ line-height: 125%;
+ font-family: monospace, fixed;
+ font-size: 105%;
+}
+
+div.fragment {
+ padding: 4px 6px;
+ margin: 4px 8px 4px 2px;
+ background-color: #FBFCFD;
+ border: 1px solid #C4CFE5;
+}
+
+div.line {
+ font-family: monospace, fixed;
+ font-size: 13px;
+ min-height: 13px;
+ line-height: 1.0;
+ text-wrap: unrestricted;
+ white-space: -moz-pre-wrap; /* Moz */
+ white-space: -pre-wrap; /* Opera 4-6 */
+ white-space: -o-pre-wrap; /* Opera 7 */
+ white-space: pre-wrap; /* CSS3 */
+ word-wrap: break-word; /* IE 5.5+ */
+ text-indent: -53px;
+ padding-left: 53px;
+ padding-bottom: 0px;
+ margin: 0px;
+ -webkit-transition-property: background-color, box-shadow;
+ -webkit-transition-duration: 0.5s;
+ -moz-transition-property: background-color, box-shadow;
+ -moz-transition-duration: 0.5s;
+ -ms-transition-property: background-color, box-shadow;
+ -ms-transition-duration: 0.5s;
+ -o-transition-property: background-color, box-shadow;
+ -o-transition-duration: 0.5s;
+ transition-property: background-color, box-shadow;
+ transition-duration: 0.5s;
+}
+
+div.line.glow {
+ background-color: cyan;
+ box-shadow: 0 0 10px cyan;
+}
+
+
+span.lineno {
+ padding-right: 4px;
+ text-align: right;
+ border-right: 2px solid #0F0;
+ background-color: #E8E8E8;
+ white-space: pre;
+}
+span.lineno a {
+ background-color: #D8D8D8;
+}
+
+span.lineno a:hover {
+ background-color: #C8C8C8;
+}
+
+div.ah {
+ background-color: black;
+ font-weight: bold;
+ color: #ffffff;
+ margin-bottom: 3px;
+ margin-top: 3px;
+ padding: 0.2em;
+ border: solid thin #333;
+ border-radius: 0.5em;
+ -webkit-border-radius: .5em;
+ -moz-border-radius: .5em;
+ box-shadow: 2px 2px 3px #999;
+ -webkit-box-shadow: 2px 2px 3px #999;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
+ background-image: -webkit-gradient(linear, left top, left bottom, from(#eee), to(#000),color-stop(0.3, #444));
+ background-image: -moz-linear-gradient(center top, #eee 0%, #444 40%, #000);
+}
+
+div.groupHeader {
+ margin-left: 16px;
+ margin-top: 12px;
+ font-weight: bold;
+}
+
+div.groupText {
+ margin-left: 16px;
+ font-style: italic;
+}
+
+body {
+ background-color: white;
+ color: black;
+ margin: 0;
+}
+
+div.contents {
+ margin-top: 10px;
+ margin-left: 12px;
+ margin-right: 8px;
+}
+
+td.indexkey {
+ background-color: #EBEFF6;
+ font-weight: bold;
+ border: 1px solid #C4CFE5;
+ margin: 2px 0px 2px 0;
+ padding: 2px 10px;
+ white-space: nowrap;
+ vertical-align: top;
+}
+
+td.indexvalue {
+ background-color: #EBEFF6;
+ border: 1px solid #C4CFE5;
+ padding: 2px 10px;
+ margin: 2px 0px;
+}
+
+tr.memlist {
+ background-color: #EEF1F7;
+}
+
+p.formulaDsp {
+ text-align: center;
+}
+
+img.formulaDsp {
+
+}
+
+img.formulaInl {
+ vertical-align: middle;
+}
+
+div.center {
+ text-align: center;
+ margin-top: 0px;
+ margin-bottom: 0px;
+ padding: 0px;
+}
+
+div.center img {
+ border: 0px;
+}
+
+address.footer {
+ text-align: right;
+ padding-right: 12px;
+}
+
+img.footer {
+ border: 0px;
+ vertical-align: middle;
+}
+
+/* @group Code Colorization */
+
+span.keyword {
+ color: #008000
+}
+
+span.keywordtype {
+ color: #604020
+}
+
+span.keywordflow {
+ color: #e08000
+}
+
+span.comment {
+ color: #800000
+}
+
+span.preprocessor {
+ color: #806020
+}
+
+span.stringliteral {
+ color: #002080
+}
+
+span.charliteral {
+ color: #008080
+}
+
+span.vhdldigit {
+ color: #ff00ff
+}
+
+span.vhdlchar {
+ color: #000000
+}
+
+span.vhdlkeyword {
+ color: #700070
+}
+
+span.vhdllogic {
+ color: #ff0000
+}
+
+blockquote {
+ background-color: #F7F8FB;
+ border-left: 2px solid #9CAFD4;
+ margin: 0 24px 0 4px;
+ padding: 0 12px 0 16px;
+}
+
+/* @end */
+
+/*
+.search {
+ color: #003399;
+ font-weight: bold;
+}
+
+form.search {
+ margin-bottom: 0px;
+ margin-top: 0px;
+}
+
+input.search {
+ font-size: 75%;
+ color: #000080;
+ font-weight: normal;
+ background-color: #e8eef2;
+}
+*/
+
+td.tiny {
+ font-size: 75%;
+}
+
+.dirtab {
+ padding: 4px;
+ border-collapse: collapse;
+ border: 1px solid #A3B4D7;
+}
+
+th.dirtab {
+ background: #EBEFF6;
+ font-weight: bold;
+}
+
+hr {
+ height: 0px;
+ border: none;
+ border-top: 1px solid #4A6AAA;
+}
+
+hr.footer {
+ height: 1px;
+}
+
+/* @group Member Descriptions */
+
+table.memberdecls {
+ border-spacing: 0px;
+ padding: 0px;
+}
+
+.memberdecls td, .fieldtable tr {
+ -webkit-transition-property: background-color, box-shadow;
+ -webkit-transition-duration: 0.5s;
+ -moz-transition-property: background-color, box-shadow;
+ -moz-transition-duration: 0.5s;
+ -ms-transition-property: background-color, box-shadow;
+ -ms-transition-duration: 0.5s;
+ -o-transition-property: background-color, box-shadow;
+ -o-transition-duration: 0.5s;
+ transition-property: background-color, box-shadow;
+ transition-duration: 0.5s;
+}
+
+.memberdecls td.glow, .fieldtable tr.glow {
+ background-color: cyan;
+ box-shadow: 0 0 15px cyan;
+}
+
+.mdescLeft, .mdescRight,
+.memItemLeft, .memItemRight,
+.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
+ background-color: #F9FAFC;
+ border: none;
+ margin: 4px;
+ padding: 1px 0 0 8px;
+}
+
+.mdescLeft, .mdescRight {
+ padding: 0px 8px 4px 8px;
+ color: #555;
+}
+
+.memSeparator {
+ border-bottom: 1px solid #DEE4F0;
+ line-height: 1px;
+ margin: 0px;
+ padding: 0px;
+}
+
+.memItemLeft, .memTemplItemLeft {
+ white-space: nowrap;
+}
+
+.memItemRight {
+ width: 100%;
+}
+
+.memTemplParams {
+ color: #4665A2;
+ white-space: nowrap;
+ font-size: 80%;
+}
+
+/* @end */
+
+/* @group Member Details */
+
+/* Styles for detailed member documentation */
+
+.memtemplate {
+ font-size: 80%;
+ color: #4665A2;
+ font-weight: normal;
+ margin-left: 9px;
+}
+
+.memnav {
+ background-color: #EBEFF6;
+ border: 1px solid #A3B4D7;
+ text-align: center;
+ margin: 2px;
+ margin-right: 15px;
+ padding: 2px;
+}
+
+.mempage {
+ width: 100%;
+}
+
+.memitem {
+ padding: 0;
+ margin-bottom: 10px;
+ margin-right: 5px;
+ -webkit-transition: box-shadow 0.5s linear;
+ -moz-transition: box-shadow 0.5s linear;
+ -ms-transition: box-shadow 0.5s linear;
+ -o-transition: box-shadow 0.5s linear;
+ transition: box-shadow 0.5s linear;
+ display: table !important;
+ width: 100%;
+}
+
+.memitem.glow {
+ box-shadow: 0 0 15px cyan;
+}
+
+.memname {
+ font-weight: bold;
+ margin-left: 6px;
+}
+
+.memname td {
+ vertical-align: bottom;
+}
+
+.memproto, dl.reflist dt {
+ border-top: 1px solid #A8B8D9;
+ border-left: 1px solid #A8B8D9;
+ border-right: 1px solid #A8B8D9;
+ padding: 6px 0px 6px 0px;
+ color: #253555;
+ font-weight: bold;
+ text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+ background-image:url('nav_f.png');
+ background-repeat:repeat-x;
+ background-color: #E2E8F2;
+ /* opera specific markup */
+ box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ border-top-right-radius: 4px;
+ border-top-left-radius: 4px;
+ /* firefox specific markup */
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+ -moz-border-radius-topright: 4px;
+ -moz-border-radius-topleft: 4px;
+ /* webkit specific markup */
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ -webkit-border-top-right-radius: 4px;
+ -webkit-border-top-left-radius: 4px;
+
+}
+
+.memdoc, dl.reflist dd {
+ border-bottom: 1px solid #A8B8D9;
+ border-left: 1px solid #A8B8D9;
+ border-right: 1px solid #A8B8D9;
+ padding: 6px 10px 2px 10px;
+ background-color: #FBFCFD;
+ border-top-width: 0;
+ background-image:url('nav_g.png');
+ background-repeat:repeat-x;
+ background-color: #FFFFFF;
+ /* opera specific markup */
+ border-bottom-left-radius: 4px;
+ border-bottom-right-radius: 4px;
+ box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+ /* firefox specific markup */
+ -moz-border-radius-bottomleft: 4px;
+ -moz-border-radius-bottomright: 4px;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
+ /* webkit specific markup */
+ -webkit-border-bottom-left-radius: 4px;
+ -webkit-border-bottom-right-radius: 4px;
+ -webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
+}
+
+dl.reflist dt {
+ padding: 5px;
+}
+
+dl.reflist dd {
+ margin: 0px 0px 10px 0px;
+ padding: 5px;
+}
+
+.paramkey {
+ text-align: right;
+}
+
+.paramtype {
+ white-space: nowrap;
+}
+
+.paramname {
+ color: #602020;
+ white-space: nowrap;
+}
+.paramname em {
+ font-style: normal;
+}
+.paramname code {
+ line-height: 14px;
+}
+
+.params, .retval, .exception, .tparams {
+ margin-left: 0px;
+ padding-left: 0px;
+}
+
+.params .paramname, .retval .paramname {
+ font-weight: bold;
+ vertical-align: top;
+}
+
+.params .paramtype {
+ font-style: italic;
+ vertical-align: top;
+}
+
+.params .paramdir {
+ font-family: "courier new",courier,monospace;
+ vertical-align: top;
+}
+
+table.mlabels {
+ border-spacing: 0px;
+}
+
+td.mlabels-left {
+ width: 100%;
+ padding: 0px;
+}
+
+td.mlabels-right {
+ vertical-align: bottom;
+ padding: 0px;
+ white-space: nowrap;
+}
+
+span.mlabels {
+ margin-left: 8px;
+}
+
+span.mlabel {
+ background-color: #728DC1;
+ border-top:1px solid #5373B4;
+ border-left:1px solid #5373B4;
+ border-right:1px solid #C4CFE5;
+ border-bottom:1px solid #C4CFE5;
+ text-shadow: none;
+ color: white;
+ margin-right: 4px;
+ padding: 2px 3px;
+ border-radius: 3px;
+ font-size: 7pt;
+ white-space: nowrap;
+ vertical-align: middle;
+}
+
+
+
+/* @end */
+
+/* these are for tree view inside a (index) page */
+
+div.directory {
+ margin: 10px 0px;
+ border-top: 1px solid #9CAFD4;
+ border-bottom: 1px solid #9CAFD4;
+ width: 100%;
+}
+
+.directory table {
+ border-collapse:collapse;
+}
+
+.directory td {
+ margin: 0px;
+ padding: 0px;
+ vertical-align: top;
+}
+
+.directory td.entry {
+ white-space: nowrap;
+ padding-right: 6px;
+ padding-top: 3px;
+}
+
+.directory td.entry a {
+ outline:none;
+}
+
+.directory td.entry a img {
+ border: none;
+}
+
+.directory td.desc {
+ width: 100%;
+ padding-left: 6px;
+ padding-right: 6px;
+ padding-top: 3px;
+ border-left: 1px solid rgba(0,0,0,0.05);
+}
+
+.directory tr.even {
+ padding-left: 6px;
+ background-color: #F7F8FB;
+}
+
+.directory img {
+ vertical-align: -30%;
+}
+
+.directory .levels {
+ white-space: nowrap;
+ width: 100%;
+ text-align: right;
+ font-size: 9pt;
+}
+
+.directory .levels span {
+ cursor: pointer;
+ padding-left: 2px;
+ padding-right: 2px;
+ color: #3D578C;
+}
+
+.arrow {
+ color: #9CAFD4;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+ cursor: pointer;
+ font-size: 80%;
+ display: inline-block;
+ width: 16px;
+ height: 22px;
+}
+
+.icon {
+ font-family: Arial, Helvetica;
+ font-weight: bold;
+ font-size: 12px;
+ height: 14px;
+ width: 16px;
+ display: inline-block;
+ background-color: #728DC1;
+ color: white;
+ text-align: center;
+ border-radius: 4px;
+ margin-left: 2px;
+ margin-right: 2px;
+}
+
+.icona {
+ width: 24px;
+ height: 22px;
+ display: inline-block;
+}
+
+.iconfopen {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('ftv2folderopen.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+.iconfclosed {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('ftv2folderclosed.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+.icondoc {
+ width: 24px;
+ height: 18px;
+ margin-bottom: 4px;
+ background-image:url('ftv2doc.png');
+ background-position: 0px -4px;
+ background-repeat: repeat-y;
+ vertical-align:top;
+ display: inline-block;
+}
+
+table.directory {
+ font: 400 14px Roboto,sans-serif;
+}
+
+/* @end */
+
+div.dynheader {
+ margin-top: 8px;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+address {
+ font-style: normal;
+ color: #2A3D61;
+}
+
+table.doxtable {
+ border-collapse:collapse;
+ margin-top: 4px;
+ margin-bottom: 4px;
+}
+
+table.doxtable td, table.doxtable th {
+ border: 1px solid #2D4068;
+ padding: 3px 7px 2px;
+}
+
+table.doxtable th {
+ background-color: #374F7F;
+ color: #FFFFFF;
+ font-size: 110%;
+ padding-bottom: 4px;
+ padding-top: 5px;
+}
+
+table.fieldtable {
+ /*width: 100%;*/
+ margin-bottom: 10px;
+ border: 1px solid #A8B8D9;
+ border-spacing: 0px;
+ -moz-border-radius: 4px;
+ -webkit-border-radius: 4px;
+ border-radius: 4px;
+ -moz-box-shadow: rgba(0, 0, 0, 0.15) 2px 2px 2px;
+ -webkit-box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+ box-shadow: 2px 2px 2px rgba(0, 0, 0, 0.15);
+}
+
+.fieldtable td, .fieldtable th {
+ padding: 3px 7px 2px;
+}
+
+.fieldtable td.fieldtype, .fieldtable td.fieldname {
+ white-space: nowrap;
+ border-right: 1px solid #A8B8D9;
+ border-bottom: 1px solid #A8B8D9;
+ vertical-align: top;
+}
+
+.fieldtable td.fieldname {
+ padding-top: 3px;
+}
+
+.fieldtable td.fielddoc {
+ border-bottom: 1px solid #A8B8D9;
+ /*width: 100%;*/
+}
+
+.fieldtable td.fielddoc p:first-child {
+ margin-top: 0px;
+}
+
+.fieldtable td.fielddoc p:last-child {
+ margin-bottom: 2px;
+}
+
+.fieldtable tr:last-child td {
+ border-bottom: none;
+}
+
+.fieldtable th {
+ background-image:url('nav_f.png');
+ background-repeat:repeat-x;
+ background-color: #E2E8F2;
+ font-size: 90%;
+ color: #253555;
+ padding-bottom: 4px;
+ padding-top: 5px;
+ text-align:left;
+ -moz-border-radius-topleft: 4px;
+ -moz-border-radius-topright: 4px;
+ -webkit-border-top-left-radius: 4px;
+ -webkit-border-top-right-radius: 4px;
+ border-top-left-radius: 4px;
+ border-top-right-radius: 4px;
+ border-bottom: 1px solid #A8B8D9;
+}
+
+
+.tabsearch {
+ top: 0px;
+ left: 10px;
+ height: 36px;
+ background-image: url('tab_b.png');
+ z-index: 101;
+ overflow: hidden;
+ font-size: 13px;
+}
+
+.navpath ul
+{
+ font-size: 11px;
+ background-image:url('tab_b.png');
+ background-repeat:repeat-x;
+ background-position: 0 -5px;
+ height:30px;
+ line-height:30px;
+ color:#8AA0CC;
+ border:solid 1px #C2CDE4;
+ overflow:hidden;
+ margin:0px;
+ padding:0px;
+}
+
+.navpath li
+{
+ list-style-type:none;
+ float:left;
+ padding-left:10px;
+ padding-right:15px;
+ background-image:url('bc_s.png');
+ background-repeat:no-repeat;
+ background-position:right;
+ color:#364D7C;
+}
+
+.navpath li.navelem a
+{
+ height:32px;
+ display:block;
+ text-decoration: none;
+ outline: none;
+ color: #283A5D;
+ font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
+ text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+ text-decoration: none;
+}
+
+.navpath li.navelem a:hover
+{
+ color:#6884BD;
+}
+
+.navpath li.footer
+{
+ list-style-type:none;
+ float:right;
+ padding-left:10px;
+ padding-right:15px;
+ background-image:none;
+ background-repeat:no-repeat;
+ background-position:right;
+ color:#364D7C;
+ font-size: 8pt;
+}
+
+
+div.summary
+{
+ float: right;
+ font-size: 8pt;
+ padding-right: 5px;
+ width: 50%;
+ text-align: right;
+}
+
+div.summary a
+{
+ white-space: nowrap;
+}
+
+div.ingroups
+{
+ font-size: 8pt;
+ width: 50%;
+ text-align: left;
+}
+
+div.ingroups a
+{
+ white-space: nowrap;
+}
+
+div.header
+{
+ background-image:url('nav_h.png');
+ background-repeat:repeat-x;
+ background-color: #F9FAFC;
+ margin: 0px;
+ border-bottom: 1px solid #C4CFE5;
+}
+
+div.headertitle
+{
+ padding: 5px 5px 5px 10px;
+}
+
+dl
+{
+ padding: 0 0 0 10px;
+}
+
+/* dl.note, dl.warning, dl.attention, dl.pre, dl.post, dl.invariant, dl.deprecated, dl.todo, dl.test, dl.bug */
+dl.section
+{
+ margin-left: 0px;
+ padding-left: 0px;
+}
+
+dl.note
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #D0C000;
+}
+
+dl.warning, dl.attention
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #FF0000;
+}
+
+dl.pre, dl.post, dl.invariant
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #00D000;
+}
+
+dl.deprecated
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #505050;
+}
+
+dl.todo
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #00C0E0;
+}
+
+dl.test
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #3030E0;
+}
+
+dl.bug
+{
+ margin-left:-7px;
+ padding-left: 3px;
+ border-left:4px solid;
+ border-color: #C08050;
+}
+
+dl.section dd {
+ margin-bottom: 6px;
+}
+
+
+#projectlogo
+{
+ text-align: center;
+ vertical-align: bottom;
+ border-collapse: separate;
+}
+
+#projectlogo img
+{
+ border: 0px none;
+}
+
+#projectname
+{
+ font: 300% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 2px 0px;
+}
+
+#projectbrief
+{
+ font: 120% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 0px;
+}
+
+#projectnumber
+{
+ font: 50% Tahoma, Arial,sans-serif;
+ margin: 0px;
+ padding: 0px;
+}
+
+#titlearea
+{
+ padding: 0px;
+ margin: 0px;
+ width: 100%;
+ border-bottom: 1px solid #5373B4;
+}
+
+.image
+{
+ text-align: center;
+}
+
+.dotgraph
+{
+ text-align: center;
+}
+
+.mscgraph
+{
+ text-align: center;
+}
+
+.diagraph
+{
+ text-align: center;
+}
+
+.caption
+{
+ font-weight: bold;
+}
+
+div.zoom
+{
+ border: 1px solid #90A5CE;
+}
+
+dl.citelist {
+ margin-bottom:50px;
+}
+
+dl.citelist dt {
+ color:#334975;
+ float:left;
+ font-weight:bold;
+ margin-right:10px;
+ padding:5px;
+}
+
+dl.citelist dd {
+ margin:2px 0;
+ padding:5px 0;
+}
+
+div.toc {
+ padding: 14px 25px;
+ background-color: #F4F6FA;
+ border: 1px solid #D8DFEE;
+ border-radius: 7px 7px 7px 7px;
+ float: right;
+ height: auto;
+ margin: 0 20px 10px 10px;
+ width: 200px;
+}
+
+div.toc li {
+ background: url("bdwn.png") no-repeat scroll 0 5px transparent;
+ font: 10px/1.2 Verdana,DejaVu Sans,Geneva,sans-serif;
+ margin-top: 5px;
+ padding-left: 10px;
+ padding-top: 2px;
+}
+
+div.toc h3 {
+ font: bold 12px/1.2 Arial,FreeSans,sans-serif;
+ color: #4665A2;
+ border-bottom: 0 none;
+ margin: 0;
+}
+
+div.toc ul {
+ list-style: none outside none;
+ border: medium none;
+ padding: 0px;
+}
+
+div.toc li.level1 {
+ margin-left: 0px;
+}
+
+div.toc li.level2 {
+ margin-left: 15px;
+}
+
+div.toc li.level3 {
+ margin-left: 30px;
+}
+
+div.toc li.level4 {
+ margin-left: 45px;
+}
+
+.inherit_header {
+ font-weight: bold;
+ color: gray;
+ cursor: pointer;
+ -webkit-touch-callout: none;
+ -webkit-user-select: none;
+ -khtml-user-select: none;
+ -moz-user-select: none;
+ -ms-user-select: none;
+ user-select: none;
+}
+
+.inherit_header td {
+ padding: 6px 0px 2px 5px;
+}
+
+.inherit {
+ display: none;
+}
+
+tr.heading h2 {
+ margin-top: 12px;
+ margin-bottom: 4px;
+}
+
+/* tooltip related style info */
+
+.ttc {
+ position: absolute;
+ display: none;
+}
+
+#powerTip {
+ cursor: default;
+ white-space: nowrap;
+ background-color: white;
+ border: 1px solid gray;
+ border-radius: 4px 4px 4px 4px;
+ box-shadow: 1px 1px 7px gray;
+ display: none;
+ font-size: smaller;
+ max-width: 80%;
+ opacity: 0.9;
+ padding: 1ex 1em 1em;
+ position: absolute;
+ z-index: 2147483647;
+}
+
+#powerTip div.ttdoc {
+ color: grey;
+ font-style: italic;
+}
+
+#powerTip div.ttname a {
+ font-weight: bold;
+}
+
+#powerTip div.ttname {
+ font-weight: bold;
+}
+
+#powerTip div.ttdeci {
+ color: #006318;
+}
+
+#powerTip div {
+ margin: 0px;
+ padding: 0px;
+ font: 12px/16px Roboto,sans-serif;
+}
+
+#powerTip:before, #powerTip:after {
+ content: "";
+ position: absolute;
+ margin: 0px;
+}
+
+#powerTip.n:after, #powerTip.n:before,
+#powerTip.s:after, #powerTip.s:before,
+#powerTip.w:after, #powerTip.w:before,
+#powerTip.e:after, #powerTip.e:before,
+#powerTip.ne:after, #powerTip.ne:before,
+#powerTip.se:after, #powerTip.se:before,
+#powerTip.nw:after, #powerTip.nw:before,
+#powerTip.sw:after, #powerTip.sw:before {
+ border: solid transparent;
+ content: " ";
+ height: 0;
+ width: 0;
+ position: absolute;
+}
+
+#powerTip.n:after, #powerTip.s:after,
+#powerTip.w:after, #powerTip.e:after,
+#powerTip.nw:after, #powerTip.ne:after,
+#powerTip.sw:after, #powerTip.se:after {
+ border-color: rgba(255, 255, 255, 0);
+}
+
+#powerTip.n:before, #powerTip.s:before,
+#powerTip.w:before, #powerTip.e:before,
+#powerTip.nw:before, #powerTip.ne:before,
+#powerTip.sw:before, #powerTip.se:before {
+ border-color: rgba(128, 128, 128, 0);
+}
+
+#powerTip.n:after, #powerTip.n:before,
+#powerTip.ne:after, #powerTip.ne:before,
+#powerTip.nw:after, #powerTip.nw:before {
+ top: 100%;
+}
+
+#powerTip.n:after, #powerTip.ne:after, #powerTip.nw:after {
+ border-top-color: #ffffff;
+ border-width: 10px;
+ margin: 0px -10px;
+}
+#powerTip.n:before {
+ border-top-color: #808080;
+ border-width: 11px;
+ margin: 0px -11px;
+}
+#powerTip.n:after, #powerTip.n:before {
+ left: 50%;
+}
+
+#powerTip.nw:after, #powerTip.nw:before {
+ right: 14px;
+}
+
+#powerTip.ne:after, #powerTip.ne:before {
+ left: 14px;
+}
+
+#powerTip.s:after, #powerTip.s:before,
+#powerTip.se:after, #powerTip.se:before,
+#powerTip.sw:after, #powerTip.sw:before {
+ bottom: 100%;
+}
+
+#powerTip.s:after, #powerTip.se:after, #powerTip.sw:after {
+ border-bottom-color: #ffffff;
+ border-width: 10px;
+ margin: 0px -10px;
+}
+
+#powerTip.s:before, #powerTip.se:before, #powerTip.sw:before {
+ border-bottom-color: #808080;
+ border-width: 11px;
+ margin: 0px -11px;
+}
+
+#powerTip.s:after, #powerTip.s:before {
+ left: 50%;
+}
+
+#powerTip.sw:after, #powerTip.sw:before {
+ right: 14px;
+}
+
+#powerTip.se:after, #powerTip.se:before {
+ left: 14px;
+}
+
+#powerTip.e:after, #powerTip.e:before {
+ left: 100%;
+}
+#powerTip.e:after {
+ border-left-color: #ffffff;
+ border-width: 10px;
+ top: 50%;
+ margin-top: -10px;
+}
+#powerTip.e:before {
+ border-left-color: #808080;
+ border-width: 11px;
+ top: 50%;
+ margin-top: -11px;
+}
+
+#powerTip.w:after, #powerTip.w:before {
+ right: 100%;
+}
+#powerTip.w:after {
+ border-right-color: #ffffff;
+ border-width: 10px;
+ top: 50%;
+ margin-top: -10px;
+}
+#powerTip.w:before {
+ border-right-color: #808080;
+ border-width: 11px;
+ top: 50%;
+ margin-top: -11px;
+}
+
+@media print
+{
+ #top { display: none; }
+ #side-nav { display: none; }
+ #nav-path { display: none; }
+ body { overflow:visible; }
+ h1, h2, h3, h4, h5, h6 { page-break-after: avoid; }
+ .summary { display: none; }
+ .memitem { page-break-inside: avoid; }
+ #doc-content
+ {
+ margin-left:0 !important;
+ height:auto !important;
+ width:auto !important;
+ overflow:inherit;
+ display:inline;
+ }
+}
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/doxygen.png b/packages/base/any/onlp/src/onlp/doc/html/doxygen.png
new file mode 100644
index 00000000..3ff17d80
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/doxygen.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/dynsections.js b/packages/base/any/onlp/src/onlp/doc/html/dynsections.js
new file mode 100644
index 00000000..85e18369
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/dynsections.js
@@ -0,0 +1,97 @@
+function toggleVisibility(linkObj)
+{
+ var base = $(linkObj).attr('id');
+ var summary = $('#'+base+'-summary');
+ var content = $('#'+base+'-content');
+ var trigger = $('#'+base+'-trigger');
+ var src=$(trigger).attr('src');
+ if (content.is(':visible')===true) {
+ content.hide();
+ summary.show();
+ $(linkObj).addClass('closed').removeClass('opened');
+ $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
+ } else {
+ content.show();
+ summary.hide();
+ $(linkObj).removeClass('closed').addClass('opened');
+ $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
+ }
+ return false;
+}
+
+function updateStripes()
+{
+ $('table.directory tr').
+ removeClass('even').filter(':visible:even').addClass('even');
+}
+
+function toggleLevel(level)
+{
+ $('table.directory tr').each(function() {
+ var l = this.id.split('_').length-1;
+ var i = $('#img'+this.id.substring(3));
+ var a = $('#arr'+this.id.substring(3));
+ if (l|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Fan Management. +More...
+#include <onlp/oids.h>#include <onlp/onlp.h>#include <BigList/biglist.h>Go to the source code of this file.
++Data Structures | |
| struct | onlp_fan_info_s |
+Macros | |
| +#define | ONLP_FAN_INFO_CAP_IS_SET(_pinfo, _name) ((_pinfo)->caps & ONLP_FAN_CAPS_##_name) |
| Determine if a fan capability is set. | |
| #define | ONLP_FAN_STATUS_PRESENT(_fi) ((_fi).hdr.status & ONLP_OID_STATUS.PRESENT) |
| #define | ONLP_FAN_STATUS_MISSING(_fi) (!ONLP_FAN_INFO_PRESENT(_fi)) |
| #define | ONLP_FAN_STATUS_FAILED(_fi) ( (_fi).hdr.status & ONLP_OID_STATUS.FAILED) |
| #define | ONLP_FAN_STATUS_NORMAL(_fi) ( ONLP_FAN_STATUS_PRESENT(_fi) && !ONLP_FAN_STATUS_FAILED(_fi) ) |
| #define | ONLP_FAN_CAPS_VALID(_e) (onlp_fan_caps_valid((_e))) |
| #define | ONLP_FAN_DIR_STRINGS |
| #define | ONLP_FAN_DIR_VALID(_e) ( (0 <= (_e)) && ((_e) <= ONLP_FAN_DIR_F2B)) |
+Typedefs | |
| typedef enum onlp_fan_caps_e | onlp_fan_caps_t |
| typedef enum onlp_fan_dir_e | onlp_fan_dir_t |
| typedef struct onlp_fan_info_s | onlp_fan_info_t |
+Enumerations | |
| enum | onlp_fan_caps_e { + ONLP_FAN_CAPS_SET_DIR = (1 << 0), +ONLP_FAN_CAPS_GET_DIR = (1 << 1), +ONLP_FAN_CAPS_SET_RPM = (1 << 2), +ONLP_FAN_CAPS_SET_PERCENTAGE = (1 << 3), + + ONLP_FAN_CAPS_GET_RPM = (1 << 4), +ONLP_FAN_CAPS_GET_PERCENTAGE = (1 << 5) + + } |
| enum | onlp_fan_dir_e { + ONLP_FAN_DIR_UNKNOWN, +ONLP_FAN_DIR_B2F, +ONLP_FAN_DIR_F2B, +ONLP_FAN_DIR_LAST = ONLP_FAN_DIR_F2B, + + ONLP_FAN_DIR_COUNT, +ONLP_FAN_DIR_INVALID = -1 + + } |
+Functions | |
| +int | onlp_fan_sw_init (void) |
| Software Initialization of the Fan module. | |
| int | onlp_fan_hw_init (uint32_t flags) |
| Hardware Initialization of the Fan module. More... | |
| int | onlp_fan_sw_denit (void) |
| Deinitialize the fan software module. More... | |
| int | onlp_fan_hdr_get (onlp_oid_t id, onlp_oid_hdr_t *hdr) |
| Retrieve the fan's OID hdr. More... | |
| int | onlp_fan_info_get (onlp_oid_t id, onlp_fan_info_t *rv) |
| Retrieve fan information. More... | |
| int | onlp_fan_rpm_set (onlp_oid_t id, int rpm) |
| Set the fan speed in RPMs. More... | |
| int | onlp_fan_percentage_set (onlp_oid_t id, int p) |
| Set the fan speed in percentage. More... | |
| int | onlp_fan_dir_set (onlp_oid_t id, onlp_fan_dir_t dir) |
| Set the fan direction. More... | |
| int | onlp_fan_info_to_user_json (onlp_fan_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a fan info structure to user JSON. More... | |
| int | onlp_fan_info_to_json (onlp_fan_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a fan info structure to JSON. More... | |
| int | onlp_fan_info_from_json (cJSON *cj, onlp_fan_info_t *info) |
| Convert a JSON object to a fan info structure. More... | |
| const char * | onlp_fan_caps_name (onlp_fan_caps_t e) |
| int | onlp_fan_caps_value (const char *str, onlp_fan_caps_t *e, int substr) |
| const char * | onlp_fan_caps_desc (onlp_fan_caps_t e) |
| int | onlp_fan_caps_valid (onlp_fan_caps_t e) |
| const char * | onlp_fan_dir_name (onlp_fan_dir_t e) |
| int | onlp_fan_dir_value (const char *str, onlp_fan_dir_t *e, int substr) |
| const char * | onlp_fan_dir_desc (onlp_fan_dir_t e) |
+Variables | |
| aim_map_si_t | onlp_fan_caps_map [] |
| aim_map_si_t | onlp_fan_caps_desc_map [] |
| aim_map_si_t | onlp_fan_dir_map [] |
| aim_map_si_t | onlp_fan_dir_desc_map [] |
Fan Management.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/fan_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/fan_8h_source.html
new file mode 100644
index 00000000..34eafc70
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/fan_8h_source.html
@@ -0,0 +1,283 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/fani_8h.html b/packages/base/any/onlp/src/onlp/doc/html/fani_8h.html
new file mode 100644
index 00000000..241245ed
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/fani_8h.html
@@ -0,0 +1,139 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Fan Platform Implementation. +More...
+#include <onlp/fan.h>Go to the source code of this file.
++Functions | |
| +int | onlp_fani_sw_init (void) |
| Software initialization of the Fan module. | |
| int | onlp_fani_hw_init (uint32_t flags) |
| Hardware initialization of the Fan module. More... | |
| int | onlp_fani_sw_denit (void) |
| Deinitialize the fan software module. More... | |
| int | onlp_fani_hdr_get (onlp_oid_id_t id, onlp_oid_hdr_t *hdr) |
| Retrieve the fan's OID hdr. More... | |
| int | onlp_fani_info_get (onlp_oid_id_t id, onlp_fan_info_t *rv) |
| Get the information structure for the given fan OID. More... | |
| int | onlp_fani_rpm_set (onlp_oid_id_t id, int rpm) |
| Set the fan speed in RPM. More... | |
| int | onlp_fani_percentage_set (onlp_oid_id_t id, int p) |
| Set the fan speed in percentage. More... | |
| int | onlp_fani_dir_set (onlp_oid_id_t id, onlp_fan_dir_t dir) |
| Set the fan direction (if supported). More... | |
Fan Platform Implementation.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/fani_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/fani_8h_source.html
new file mode 100644
index 00000000..ed65ed18
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/fani_8h_source.html
@@ -0,0 +1,157 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/files.html b/packages/base/any/onlp/src/onlp/doc/html/files.html
new file mode 100644
index 00000000..b32873e7
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/files.html
@@ -0,0 +1,131 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
| ▼ module | |
| ▼ inc | |
| ▼ onlp | |
| ▼ platformi | |
| attributei.h | |
| base.h | |
| chassisi.h | Chassis Platform Interface |
| debugi.h | |
| fani.h | Fan Platform Implementation |
| ledi.h | |
| platformi.h | |
| psui.h | Power Supply Management Implementation |
| sfpi.h | SFP Platform Implementation Interface. This interface must be implemented and available for all platforms that support SFP interfaces |
| thermali.h | Thermal Sensor Platform Implementation |
| attribute.h | Attributes |
| chassis.h | Chassis OID Interface |
| debug.h | |
| fan.h | Fan Management |
| generic.h | Generic OID Interface |
| led.h | |
| module.h | Module OID Interface |
| oids.h | |
| onlp.h | |
| onlp_config.h | Onlp Configuration Header |
| onlp_dox.h | |
| onlp_porting.h | Onlp Porting Macros |
| platform.h | |
| psu.h | Power Supply Management |
| sfp.h | SFP Management Interface |
| stdattrs.h | Standard OID Attributes |
| thermal.h | Thermal Sensor Management |
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2blank.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2blank.png
new file mode 100644
index 00000000..63c605bb
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2blank.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2doc.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2doc.png
new file mode 100644
index 00000000..17edabff
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2doc.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2folderclosed.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2folderclosed.png
new file mode 100644
index 00000000..bb8ab35e
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2folderclosed.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2folderopen.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2folderopen.png
new file mode 100644
index 00000000..d6c7f676
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2folderopen.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2lastnode.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2lastnode.png
new file mode 100644
index 00000000..63c605bb
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2lastnode.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2link.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2link.png
new file mode 100644
index 00000000..17edabff
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2link.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2mlastnode.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2mlastnode.png
new file mode 100644
index 00000000..0b63f6d3
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2mlastnode.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2mnode.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2mnode.png
new file mode 100644
index 00000000..0b63f6d3
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2mnode.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2node.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2node.png
new file mode 100644
index 00000000..63c605bb
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2node.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2plastnode.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2plastnode.png
new file mode 100644
index 00000000..c6ee22f9
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2plastnode.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2pnode.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2pnode.png
new file mode 100644
index 00000000..c6ee22f9
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2pnode.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2splitbar.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2splitbar.png
new file mode 100644
index 00000000..fe895f2c
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2splitbar.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ftv2vertline.png b/packages/base/any/onlp/src/onlp/doc/html/ftv2vertline.png
new file mode 100644
index 00000000..63c605bb
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/ftv2vertline.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/functions.html b/packages/base/any/onlp/src/onlp/doc/html/functions.html
new file mode 100644
index 00000000..54cd8893
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/functions.html
@@ -0,0 +1,334 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/functions_vars.html b/packages/base/any/onlp/src/onlp/doc/html/functions_vars.html
new file mode 100644
index 00000000..15ba8993
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/functions_vars.html
@@ -0,0 +1,334 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/generic_8h.html b/packages/base/any/onlp/src/onlp/doc/html/generic_8h.html
new file mode 100644
index 00000000..d40c1c63
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/generic_8h.html
@@ -0,0 +1,157 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Generic OID Interface. +More...
+#include <onlp/onlp_config.h>#include <onlp/onlp.h>#include <onlplib/onie.h>#include <onlplib/pi.h>#include <onlp/oids.h>Go to the source code of this file.
++Data Structures | |
| struct | onlp_generic_info_s |
| Generic OID Information Structure. More... | |
+Typedefs | |
| +typedef struct onlp_generic_info_s | onlp_generic_info_t |
| Generic OID Information Structure. | |
+Functions | |
| int | onlp_generic_sw_init (void) |
| Initialize the module software module. More... | |
| int | onlp_generic_hw_init (uint32_t flags) |
| Initialize the module. More... | |
| int | onlp_generic_sw_denit (void) |
| Deinitialize the generic software module. More... | |
| int | onlp_generic_hdr_get (onlp_oid_t oid, onlp_oid_hdr_t *hdr) |
| Get the generic header structure. More... | |
| int | onlp_generic_info_get (onlp_oid_t oid, onlp_generic_info_t *info) |
| Get the module info structure. More... | |
| int | onlp_generic_info_to_user_json (onlp_generic_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a generic info structure to user JSON. More... | |
| int | onlp_generic_info_to_json (onlp_generic_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a generic info structure to JSON. More... | |
| int | onlp_generic_info_from_json (cJSON *cj, onlp_generic_info_t *info) |
| Convert a JSON object to a generic info structure. More... | |
Generic OID Interface.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/generic_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/generic_8h_source.html
new file mode 100644
index 00000000..9aa442e3
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/generic_8h_source.html
@@ -0,0 +1,167 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/globals.html b/packages/base/any/onlp/src/onlp/doc/html/globals.html
new file mode 100644
index 00000000..9cb6f6c6
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/globals.html
@@ -0,0 +1,948 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/globals_defs.html b/packages/base/any/onlp/src/onlp/doc/html/globals_defs.html
new file mode 100644
index 00000000..017e2d8b
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/globals_defs.html
@@ -0,0 +1,267 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/globals_enum.html b/packages/base/any/onlp/src/onlp/doc/html/globals_enum.html
new file mode 100644
index 00000000..5d0dbd2d
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/globals_enum.html
@@ -0,0 +1,131 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/globals_func.html b/packages/base/any/onlp/src/onlp/doc/html/globals_func.html
new file mode 100644
index 00000000..4a1ae2d6
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/globals_func.html
@@ -0,0 +1,651 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/globals_type.html b/packages/base/any/onlp/src/onlp/doc/html/globals_type.html
new file mode 100644
index 00000000..fcbdb2c6
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/globals_type.html
@@ -0,0 +1,161 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/globals_vars.html b/packages/base/any/onlp/src/onlp/doc/html/globals_vars.html
new file mode 100644
index 00000000..6b8a82da
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/globals_vars.html
@@ -0,0 +1,161 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__assets.html b/packages/base/any/onlp/src/onlp/doc/html/group__assets.html
new file mode 100644
index 00000000..fdaa65a8
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__assets.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__attributes.html b/packages/base/any/onlp/src/onlp/doc/html/group__attributes.html
new file mode 100644
index 00000000..2e27f7f9
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__attributes.html
@@ -0,0 +1,722 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Macros | |
| +#define | ONLP_ATTRIBUTE_EQUALS(_a, _b) (!strcmp(_a, _b)) |
| Attribute comparitor. | |
+Functions | |
| int | onlp_attribute_sw_init (void) |
| Initialize the attribute subsystem. More... | |
| int | onlp_attribute_hw_init (uint32_t flags) |
| Hardware initialization of the attribute subsystem. More... | |
| int | onlp_attribute_supported (onlp_oid_t oid, const char *attribute) |
| Determine whether the OID supports the given attribute. More... | |
| int | onlp_attribute_set (onlp_oid_t oid, const char *attribute, void *value) |
| Set an attribute on the given OID. More... | |
| int | onlp_attribute_get (onlp_oid_t oid, const char *attribute, void **value) |
| Get an attribute from the given OID. More... | |
| int | onlp_attribute_free (onlp_oid_t oid, const char *attribute, void *value) |
| Free an attribute value returned from onlp_attribute_get(). More... | |
| int | onlp_attribute_onie_info_get (onlp_oid_t oid, onlp_onie_info_t **rp) |
| Request the ONIE attribute. More... | |
| int | onlp_attribute_onie_info_free (onlp_oid_t oid, onlp_onie_info_t *p) |
| Free an ONIE attribute pointer. More... | |
| int | onlp_attribute_onie_info_get_json (onlp_oid_t oid, cJSON **rp) |
| Request the ONIE attribute in JSON. More... | |
| int | onlp_attribute_onie_info_show (onlp_oid_t oid, aim_pvs_t *pvs) |
| Show the ONIE attribute. More... | |
| int | onlp_attribute_onie_info_show_json (onlp_oid_t oid, aim_pvs_t *pvs) |
| Show the ONIE attribute (JSON) More... | |
| int | onlp_attribute_asset_info_get (onlp_oid_t oid, onlp_asset_info_t **rp) |
| Determine if the ONIE attribute is supported. More... | |
| int | onlp_attribute_asset_info_free (onlp_oid_t oid, onlp_asset_info_t *p) |
| Free an asset attribute pointer. More... | |
| int | onlp_attribute_asset_info_get_json (onlp_oid_t oid, cJSON **rp) |
| Request the asset attribute in JSON. More... | |
| int | onlp_attribute_asset_info_show (onlp_oid_t oid, aim_pvs_t *pvs) |
| Show the asset attribute. More... | |
| int | onlp_attribute_asset_info_show_json (onlp_oid_t oid, aim_pvs_t *pvs) |
| Show the asset attribute (JSON). More... | |
| int onlp_attribute_asset_info_free | +( | +onlp_oid_t | +oid, | +
| + | + | onlp_asset_info_t * | +p | +
| + | ) | ++ |
Free an asset attribute pointer.
+| oid | The target oid. |
| p | The asset attribute pointer. |
| int onlp_attribute_asset_info_get | +( | +onlp_oid_t | +oid, | +
| + | + | onlp_asset_info_t ** | +rp | +
| + | ) | ++ |
Determine if the ONIE attribute is supported.
+| oid | The target OID. |
| oid | The target oid. | |
| [out] | rp | Receives the Asset information structure pointer. |
| int onlp_attribute_asset_info_get_json | +( | +onlp_oid_t | +oid, | +
| + | + | cJSON ** | +rp | +
| + | ) | ++ |
Request the asset attribute in JSON.
+| oid | The target oid. | |
| [out] | rp | Receives the cJSON object. |
| int onlp_attribute_asset_info_show | +( | +onlp_oid_t | +oid, | +
| + | + | aim_pvs_t * | +pvs | +
| + | ) | ++ |
Show the asset attribute.
+| oid | The target oid. |
| pvs | The output pvs. |
| int onlp_attribute_asset_info_show_json | +( | +onlp_oid_t | +oid, | +
| + | + | aim_pvs_t * | +pvs | +
| + | ) | ++ |
Show the asset attribute (JSON).
+| oid | The target oid. |
| pvs | The output pvs. |
| int onlp_attribute_free | +( | +onlp_oid_t | +oid, | +
| + | + | const char * | +attribute, | +
| + | + | void * | +value | +
| + | ) | ++ |
Free an attribute value returned from onlp_attribute_get().
+| oid | The OID. |
| attribute | The attribute. |
| value | The value. |
| int onlp_attribute_get | +( | +onlp_oid_t | +oid, | +
| + | + | const char * | +attribute, | +
| + | + | void ** | +value | +
| + | ) | ++ |
Get an attribute from the given OID.
+| oid | The OID. | |
| attribute | The attribute to retrieve. | |
| [out] | value | Receives the attribute's value. |
| int onlp_attribute_hw_init | +( | +uint32_t | +flags | ) | ++ |
Hardware initialization of the attribute subsystem.
+| flags | The initialization flags. |
| int onlp_attribute_onie_info_free | +( | +onlp_oid_t | +oid, | +
| + | + | onlp_onie_info_t * | +p | +
| + | ) | ++ |
Free an ONIE attribute pointer.
+| oid | The target OID. |
| p | The ONIE attribute pointer. |
| int onlp_attribute_onie_info_get | +( | +onlp_oid_t | +oid, | +
| + | + | onlp_onie_info_t ** | +rp | +
| + | ) | ++ |
Request the ONIE attribute.
+| oid | The target OID. | |
| [out] | rp | Receives the ONIE information structure pointer. |
| int onlp_attribute_onie_info_get_json | +( | +onlp_oid_t | +oid, | +
| + | + | cJSON ** | +rp | +
| + | ) | ++ |
Request the ONIE attribute in JSON.
+| oid | The target OID. | |
| [out] | rp | Receives the cJSON object. |
| int onlp_attribute_onie_info_show | +( | +onlp_oid_t | +oid, | +
| + | + | aim_pvs_t * | +pvs | +
| + | ) | ++ |
Show the ONIE attribute.
+| oid | The target OID. |
| pvs | The output pvs. |
| int onlp_attribute_onie_info_show_json | +( | +onlp_oid_t | +oid, | +
| + | + | aim_pvs_t * | +pvs | +
| + | ) | ++ |
Show the ONIE attribute (JSON)
+| oid | The target OID. |
| pvs | The output pvs. |
| int onlp_attribute_set | +( | +onlp_oid_t | +oid, | +
| + | + | const char * | +attribute, | +
| + | + | void * | +value | +
| + | ) | ++ |
Set an attribute on the given OID.
+| oid | The OID. |
| attribute | The attribute name. |
| value | A pointer to the value. |
| int onlp_attribute_supported | +( | +onlp_oid_t | +oid, | +
| + | + | const char * | +attribute | +
| + | ) | ++ |
Determine whether the OID supports the given attribute.
+| oid | The OID. |
| attribute | The attribute name. |
| int onlp_attribute_sw_init | +( | +void | +) | ++ |
Initialize the attribute subsystem.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__chassisi.html b/packages/base/any/onlp/src/onlp/doc/html/group__chassisi.html
new file mode 100644
index 00000000..f6231085
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__chassisi.html
@@ -0,0 +1,227 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Functions | |
| +int | onlp_chassisi_sw_init (void) |
| Software initializaiton of the Chassis module. | |
| int | onlp_chassisi_hw_init (uint32_t flags) |
| Hardware initializaiton of the Chassis module. More... | |
| int | onlp_chassisi_sw_denit (void) |
| Deinitialize the chassis software module. More... | |
| int | onlp_chassisi_hdr_get (onlp_oid_id_t id, onlp_oid_hdr_t *hdr) |
| Get the chassis hdr structure. More... | |
| int | onlp_chassisi_info_get (onlp_oid_id_t id, onlp_chassis_info_t *info) |
| Get the chassis info structure. More... | |
| int onlp_chassisi_hdr_get | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_oid_hdr_t * | +hdr | +
| + | ) | ++ |
Get the chassis hdr structure.
+| id | The Chassis OID. | |
| [out] | hdr | Receives the header. |
| int onlp_chassisi_hw_init | +( | +uint32_t | +flags | ) | ++ |
Hardware initializaiton of the Chassis module.
+| flags | The hardware initialization flags. |
| int onlp_chassisi_info_get | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_chassis_info_t * | +info | +
| + | ) | ++ |
Get the chassis info structure.
+| id | The Chassis OID. | |
| [out] | info | Receives the chassis information. |
| int onlp_chassisi_sw_denit | +( | +void | +) | ++ |
Deinitialize the chassis software module.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__fani.html b/packages/base/any/onlp/src/onlp/doc/html/group__fani.html
new file mode 100644
index 00000000..989450f3
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__fani.html
@@ -0,0 +1,343 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Functions | |
| +int | onlp_fani_sw_init (void) |
| Software initialization of the Fan module. | |
| int | onlp_fani_hw_init (uint32_t flags) |
| Hardware initialization of the Fan module. More... | |
| int | onlp_fani_sw_denit (void) |
| Deinitialize the fan software module. More... | |
| int | onlp_fani_hdr_get (onlp_oid_id_t id, onlp_oid_hdr_t *hdr) |
| Retrieve the fan's OID hdr. More... | |
| int | onlp_fani_info_get (onlp_oid_id_t id, onlp_fan_info_t *rv) |
| Get the information structure for the given fan OID. More... | |
| int | onlp_fani_rpm_set (onlp_oid_id_t id, int rpm) |
| Set the fan speed in RPM. More... | |
| int | onlp_fani_percentage_set (onlp_oid_id_t id, int p) |
| Set the fan speed in percentage. More... | |
| int | onlp_fani_dir_set (onlp_oid_id_t id, onlp_fan_dir_t dir) |
| Set the fan direction (if supported). More... | |
| int onlp_fani_dir_set | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_fan_dir_t | +dir | +
| + | ) | ++ |
Set the fan direction (if supported).
+| id | The fan OID |
| dir | The direction. |
| int onlp_fani_hdr_get | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_oid_hdr_t * | +hdr | +
| + | ) | ++ |
Retrieve the fan's OID hdr.
+| id | The fan OID. | |
| [out] | hdr | Receives the OID header. |
| int onlp_fani_hw_init | +( | +uint32_t | +flags | ) | ++ |
Hardware initialization of the Fan module.
+| flags | The hardware initialization flags. |
| int onlp_fani_info_get | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_fan_info_t * | +rv | +
| + | ) | ++ |
Get the information structure for the given fan OID.
+| id | The fan OID | |
| [out] | rv | Receives the fan information. |
| int onlp_fani_percentage_set | +( | +onlp_oid_id_t | +id, | +
| + | + | int | +p | +
| + | ) | ++ |
Set the fan speed in percentage.
+| id | The fan OID. |
| p | The new fan speed percentage. |
| int onlp_fani_rpm_set | +( | +onlp_oid_id_t | +id, | +
| + | + | int | +rpm | +
| + | ) | ++ |
Set the fan speed in RPM.
+| id | The fan OID |
| rpm | The new RPM |
| int onlp_fani_sw_denit | +( | +void | +) | ++ |
Deinitialize the fan software module.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__module-interfaces.html b/packages/base/any/onlp/src/onlp/doc/html/group__module-interfaces.html
new file mode 100644
index 00000000..8e0e2957
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__module-interfaces.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__modulei.html b/packages/base/any/onlp/src/onlp/doc/html/group__modulei.html
new file mode 100644
index 00000000..46016b1a
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__modulei.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__oid-chassis.html b/packages/base/any/onlp/src/onlp/doc/html/group__oid-chassis.html
new file mode 100644
index 00000000..ed50f066
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__oid-chassis.html
@@ -0,0 +1,521 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Data Structures | |
| struct | onlp_chassis_info_s |
| Chassis Information Structure. More... | |
+Typedefs | |
| +typedef struct onlp_chassis_info_s | onlp_chassis_info_t |
| Chassis Information Structure. | |
+Functions | |
| int | onlp_chassis_sw_init (void) |
| Initialize the chassis software module. More... | |
| int | onlp_chassis_hw_init (uint32_t flags) |
| Initialize the chassis. More... | |
| int | onlp_chassis_sw_denit (void) |
| Deinitialize the chassis software module. More... | |
| int | onlp_chassis_hdr_get (onlp_oid_t oid, onlp_oid_hdr_t *hdr) |
| Get the Chassis Header structure. More... | |
| int | onlp_chassis_info_get (onlp_oid_t oid, onlp_chassis_info_t *info) |
| Get the chassis info structure. More... | |
| int | onlp_chassis_info_to_user_json (onlp_chassis_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a chassis info structure to user JSON. More... | |
| int | onlp_chassis_info_to_json (onlp_chassis_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a chassis info structure to JSON. More... | |
| int | onlp_chassis_info_from_json (cJSON *cj, onlp_chassis_info_t *info) |
| Convert a JSON object to a chassis info structure. More... | |
| int | onlp_chassis_environment_to_json (cJSON **cjp, uint32_t flags) |
| Get the user or full environmental json data. More... | |
| int | onlp_chassis_environment_show (aim_pvs_t *pvs, uint32_t flags) |
| Show the environmental data. More... | |
| int | onlp_chassis_debug_get_json (cJSON **rv) |
| Construct the Chassis debug JSON object. More... | |
| int | onlp_chassis_debug_show (aim_pvs_t *pvs) |
| Show the Chassis debug information. `*. More... | |
| int onlp_chassis_debug_get_json | +( | +cJSON ** | +rv | ) | ++ |
Construct the Chassis debug JSON object.
+| [out] | rv | Receives the JSON object. |
| int onlp_chassis_debug_show | +( | +aim_pvs_t * | +pvs | ) | ++ |
Show the Chassis debug information. `*.
+| pvs | The output pvs. |
| int onlp_chassis_environment_show | +( | +aim_pvs_t * | +pvs, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Show the environmental data.
+| pvs | The output pvs. |
| flags | Zero or ONLP_OID_JSON_FLAG_TO_USER_JSON only. |
| int onlp_chassis_environment_to_json | +( | +cJSON ** | +cjp, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Get the user or full environmental json data.
+| [out] | cjp | Receives the JSON data. |
| flags | Zero or ONLP_OID_JSON_FLAG_TO_USER_JSON only. |
with keys in the following order: Chassis Fans Chassis Thermals Chassis PSUs
+ +| int onlp_chassis_hdr_get | +( | +onlp_oid_t | +oid, | +
| + | + | onlp_oid_hdr_t * | +hdr | +
| + | ) | ++ |
Get the Chassis Header structure.
+| oid | The Chassis oid. | |
| [out] | hdr | Receives the hdr. |
| int onlp_chassis_hw_init | +( | +uint32_t | +flags | ) | ++ |
Initialize the chassis.
+| flags | The initialization flags. |
| int onlp_chassis_info_from_json | +( | +cJSON * | +cj, | +
| + | + | onlp_chassis_info_t * | +info | +
| + | ) | ++ |
Convert a JSON object to a chassis info structure.
+| cj | The JSON object. | |
| [out] | info | Receives the chassis info. |
| int onlp_chassis_info_get | +( | +onlp_oid_t | +oid, | +
| + | + | onlp_chassis_info_t * | +info | +
| + | ) | ++ |
Get the chassis info structure.
+| oid | The Chassis oid. | |
| [out] | info |
| int onlp_chassis_info_to_json | +( | +onlp_chassis_info_t * | +info, | +
| + | + | cJSON ** | +cj, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert a chassis info structure to JSON.
+| info | The chassis info structure. | |
| [out] | cj | Receives the JSON object. |
| flags | The JSON format flags. |
| int onlp_chassis_info_to_user_json | +( | +onlp_chassis_info_t * | +info, | +
| + | + | cJSON ** | +cj, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert a chassis info structure to user JSON.
+| info | The chassis info structure. | |
| [out] | cj | Receives the JSON object. |
| flags | The JSON format flags. |
| int onlp_chassis_sw_denit | +( | +void | +) | ++ |
Deinitialize the chassis software module.
+| int onlp_chassis_sw_init | +( | +void | +) | ++ |
Initialize the chassis software module.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__oid-fan.html b/packages/base/any/onlp/src/onlp/doc/html/group__oid-fan.html
new file mode 100644
index 00000000..75de909f
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__oid-fan.html
@@ -0,0 +1,954 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Data Structures | |
| struct | onlp_fan_info_s |
+Macros | |
| +#define | ONLP_FAN_INFO_CAP_IS_SET(_pinfo, _name) ((_pinfo)->caps & ONLP_FAN_CAPS_##_name) |
| Determine if a fan capability is set. | |
| #define | ONLP_FAN_STATUS_PRESENT(_fi) ((_fi).hdr.status & ONLP_OID_STATUS.PRESENT) |
| #define | ONLP_FAN_STATUS_MISSING(_fi) (!ONLP_FAN_INFO_PRESENT(_fi)) |
| #define | ONLP_FAN_STATUS_FAILED(_fi) ( (_fi).hdr.status & ONLP_OID_STATUS.FAILED) |
| #define | ONLP_FAN_STATUS_NORMAL(_fi) ( ONLP_FAN_STATUS_PRESENT(_fi) && !ONLP_FAN_STATUS_FAILED(_fi) ) |
| #define | ONLP_FAN_CAPS_VALID(_e) (onlp_fan_caps_valid((_e))) |
| #define | ONLP_FAN_DIR_STRINGS |
| #define | ONLP_FAN_DIR_VALID(_e) ( (0 <= (_e)) && ((_e) <= ONLP_FAN_DIR_F2B)) |
+Typedefs | |
| typedef enum onlp_fan_caps_e | onlp_fan_caps_t |
| typedef enum onlp_fan_dir_e | onlp_fan_dir_t |
| typedef struct onlp_fan_info_s | onlp_fan_info_t |
+Enumerations | |
| enum | onlp_fan_caps_e { + ONLP_FAN_CAPS_SET_DIR = (1 << 0), +ONLP_FAN_CAPS_GET_DIR = (1 << 1), +ONLP_FAN_CAPS_SET_RPM = (1 << 2), +ONLP_FAN_CAPS_SET_PERCENTAGE = (1 << 3), + + ONLP_FAN_CAPS_GET_RPM = (1 << 4), +ONLP_FAN_CAPS_GET_PERCENTAGE = (1 << 5) + + } |
| enum | onlp_fan_dir_e { + ONLP_FAN_DIR_UNKNOWN, +ONLP_FAN_DIR_B2F, +ONLP_FAN_DIR_F2B, +ONLP_FAN_DIR_LAST = ONLP_FAN_DIR_F2B, + + ONLP_FAN_DIR_COUNT, +ONLP_FAN_DIR_INVALID = -1 + + } |
+Functions | |
| +int | onlp_fan_sw_init (void) |
| Software Initialization of the Fan module. | |
| int | onlp_fan_hw_init (uint32_t flags) |
| Hardware Initialization of the Fan module. More... | |
| int | onlp_fan_sw_denit (void) |
| Deinitialize the fan software module. More... | |
| int | onlp_fan_hdr_get (onlp_oid_t id, onlp_oid_hdr_t *hdr) |
| Retrieve the fan's OID hdr. More... | |
| int | onlp_fan_info_get (onlp_oid_t id, onlp_fan_info_t *rv) |
| Retrieve fan information. More... | |
| int | onlp_fan_rpm_set (onlp_oid_t id, int rpm) |
| Set the fan speed in RPMs. More... | |
| int | onlp_fan_percentage_set (onlp_oid_t id, int p) |
| Set the fan speed in percentage. More... | |
| int | onlp_fan_dir_set (onlp_oid_t id, onlp_fan_dir_t dir) |
| Set the fan direction. More... | |
| int | onlp_fan_info_to_user_json (onlp_fan_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a fan info structure to user JSON. More... | |
| int | onlp_fan_info_to_json (onlp_fan_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a fan info structure to JSON. More... | |
| int | onlp_fan_info_from_json (cJSON *cj, onlp_fan_info_t *info) |
| Convert a JSON object to a fan info structure. More... | |
| const char * | onlp_fan_caps_name (onlp_fan_caps_t e) |
| int | onlp_fan_caps_value (const char *str, onlp_fan_caps_t *e, int substr) |
| const char * | onlp_fan_caps_desc (onlp_fan_caps_t e) |
| int | onlp_fan_caps_valid (onlp_fan_caps_t e) |
| const char * | onlp_fan_dir_name (onlp_fan_dir_t e) |
| int | onlp_fan_dir_value (const char *str, onlp_fan_dir_t *e, int substr) |
| const char * | onlp_fan_dir_desc (onlp_fan_dir_t e) |
+Variables | |
| aim_map_si_t | onlp_fan_caps_map [] |
| aim_map_si_t | onlp_fan_caps_desc_map [] |
| aim_map_si_t | onlp_fan_dir_map [] |
| aim_map_si_t | onlp_fan_dir_desc_map [] |
| #define ONLP_FAN_CAPS_VALID | +( | ++ | _e | ) | +(onlp_fan_caps_valid((_e))) | +
validator
+ +| #define ONLP_FAN_DIR_STRINGS | +
Strings macro.
+ +| #define ONLP_FAN_DIR_VALID | +( | ++ | _e | ) | +( (0 <= (_e)) && ((_e) <= ONLP_FAN_DIR_F2B)) | +
validator
+ +| #define ONLP_FAN_STATUS_FAILED | +( | ++ | _fi | ) | +( (_fi).hdr.status & ONLP_OID_STATUS.FAILED) | +
Fan has failed.
+ +| #define ONLP_FAN_STATUS_MISSING | +( | ++ | _fi | ) | +(!ONLP_FAN_INFO_PRESENT(_fi)) | +
Fan is missing.
+ +| #define ONLP_FAN_STATUS_NORMAL | +( | ++ | _fi | ) | +( ONLP_FAN_STATUS_PRESENT(_fi) && !ONLP_FAN_STATUS_FAILED(_fi) ) | +
Fan is operating normally
+ +| #define ONLP_FAN_STATUS_PRESENT | +( | ++ | _fi | ) | +((_fi).hdr.status & ONLP_OID_STATUS.PRESENT) | +
Fan is present.
+ +| typedef enum onlp_fan_caps_e onlp_fan_caps_t | +
onlp_fan_caps
+ +| typedef enum onlp_fan_dir_e onlp_fan_dir_t | +
onlp_fan_dir
+ +| typedef struct onlp_fan_info_s onlp_fan_info_t | +
Fan information structure.
+ +| enum onlp_fan_caps_e | +
onlp_fan_caps
+ +| enum onlp_fan_dir_e | +
onlp_fan_dir
+ +| const char* onlp_fan_caps_desc | +( | +onlp_fan_caps_t | +e | ) | ++ |
Enum descriptions.
+ +| const char* onlp_fan_caps_name | +( | +onlp_fan_caps_t | +e | ) | ++ |
Enum names.
+ +| int onlp_fan_caps_valid | +( | +onlp_fan_caps_t | +e | ) | ++ |
Enum validator.
+ +| int onlp_fan_caps_value | +( | +const char * | +str, | +
| + | + | onlp_fan_caps_t * | +e, | +
| + | + | int | +substr | +
| + | ) | ++ |
Enum values.
+ +| const char* onlp_fan_dir_desc | +( | +onlp_fan_dir_t | +e | ) | ++ |
Enum descriptions.
+ +| const char* onlp_fan_dir_name | +( | +onlp_fan_dir_t | +e | ) | ++ |
Enum names.
+ +| int onlp_fan_dir_set | +( | +onlp_oid_t | +id, | +
| + | + | onlp_fan_dir_t | +dir | +
| + | ) | ++ |
Set the fan direction.
+| id | The fan OID. |
| dir | The fan direction (B2F or F2B) |
| int onlp_fan_dir_value | +( | +const char * | +str, | +
| + | + | onlp_fan_dir_t * | +e, | +
| + | + | int | +substr | +
| + | ) | ++ |
Enum values.
+ +| int onlp_fan_hdr_get | +( | +onlp_oid_t | +id, | +
| + | + | onlp_oid_hdr_t * | +hdr | +
| + | ) | ++ |
Retrieve the fan's OID hdr.
+| id | The fan OID. | |
| [out] | hdr | Receives the OID header. |
| int onlp_fan_hw_init | +( | +uint32_t | +flags | ) | ++ |
Hardware Initialization of the Fan module.
+| flags | The hardware initialization flags. |
| int onlp_fan_info_from_json | +( | +cJSON * | +cj, | +
| + | + | onlp_fan_info_t * | +info | +
| + | ) | ++ |
Convert a JSON object to a fan info structure.
+| cj | The JSON object. | |
| [out] | info | Recieves the fan info structure. |
| int onlp_fan_info_get | +( | +onlp_oid_t | +id, | +
| + | + | onlp_fan_info_t * | +rv | +
| + | ) | ++ |
Retrieve fan information.
+| id | The fan OID. | |
| [out] | rv | Receives the fan information. |
| int onlp_fan_info_to_json | +( | +onlp_fan_info_t * | +info, | +
| + | + | cJSON ** | +cj, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert a fan info structure to JSON.
+| info | The fan info structure. | |
| [out] | cj | Receives the JSON object. |
| flags | The JSON format flags. |
| int onlp_fan_info_to_user_json | +( | +onlp_fan_info_t * | +info, | +
| + | + | cJSON ** | +cj, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert a fan info structure to user JSON.
+| info | The fan info structure. | |
| [out] | cj | Receives the JSON object. |
| flags | The JSON format flags. |
| int onlp_fan_percentage_set | +( | +onlp_oid_t | +id, | +
| + | + | int | +p | +
| + | ) | ++ |
Set the fan speed in percentage.
+| id | The fan OID. |
| p | The percentage. |
| int onlp_fan_rpm_set | +( | +onlp_oid_t | +id, | +
| + | + | int | +rpm | +
| + | ) | ++ |
Set the fan speed in RPMs.
+| id | The fan OID. |
| rpm | The new RPM. |
| int onlp_fan_sw_denit | +( | +void | +) | ++ |
Deinitialize the fan software module.
+| aim_map_si_t onlp_fan_caps_desc_map[] | +
onlp_fan_caps_desc_map table.
+ +| aim_map_si_t onlp_fan_caps_map[] | +
onlp_fan_caps_map table.
+ +| aim_map_si_t onlp_fan_dir_desc_map[] | +
onlp_fan_dir_desc_map table.
+ +| aim_map_si_t onlp_fan_dir_map[] | +
onlp_fan_dir_map table.
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__oid-generic.html b/packages/base/any/onlp/src/onlp/doc/html/group__oid-generic.html
new file mode 100644
index 00000000..6c6112bb
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__oid-generic.html
@@ -0,0 +1,388 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Data Structures | |
| struct | onlp_generic_info_s |
| Generic OID Information Structure. More... | |
+Typedefs | |
| +typedef struct onlp_generic_info_s | onlp_generic_info_t |
| Generic OID Information Structure. | |
+Functions | |
| int | onlp_generic_sw_init (void) |
| Initialize the module software module. More... | |
| int | onlp_generic_hw_init (uint32_t flags) |
| Initialize the module. More... | |
| int | onlp_generic_sw_denit (void) |
| Deinitialize the generic software module. More... | |
| int | onlp_generic_hdr_get (onlp_oid_t oid, onlp_oid_hdr_t *hdr) |
| Get the generic header structure. More... | |
| int | onlp_generic_info_get (onlp_oid_t oid, onlp_generic_info_t *info) |
| Get the module info structure. More... | |
| int | onlp_generic_info_to_user_json (onlp_generic_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a generic info structure to user JSON. More... | |
| int | onlp_generic_info_to_json (onlp_generic_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a generic info structure to JSON. More... | |
| int | onlp_generic_info_from_json (cJSON *cj, onlp_generic_info_t *info) |
| Convert a JSON object to a generic info structure. More... | |
| int onlp_generic_hdr_get | +( | +onlp_oid_t | +oid, | +
| + | + | onlp_oid_hdr_t * | +hdr | +
| + | ) | ++ |
Get the generic header structure.
+| oid | The Generic oid. | |
| [out] | hdr | Receives the header. |
| int onlp_generic_hw_init | +( | +uint32_t | +flags | ) | ++ |
Initialize the module.
+| flags | The initialization flags. |
| int onlp_generic_info_from_json | +( | +cJSON * | +cj, | +
| + | + | onlp_generic_info_t * | +info | +
| + | ) | ++ |
Convert a JSON object to a generic info structure.
+| cj | The JSON object. | |
| [out] | info | Receives the generic info structure. |
| int onlp_generic_info_get | +( | +onlp_oid_t | +oid, | +
| + | + | onlp_generic_info_t * | +info | +
| + | ) | ++ |
Get the module info structure.
+| oid | The Generic oid. | |
| [out] | info |
| int onlp_generic_info_to_json | +( | +onlp_generic_info_t * | +info, | +
| + | + | cJSON ** | +cj, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert a generic info structure to JSON.
+| info | The generic info structure. | |
| [out] | cj | Receives the JSON object. |
| flags | The JSON format flags. |
| int onlp_generic_info_to_user_json | +( | +onlp_generic_info_t * | +info, | +
| + | + | cJSON ** | +cj, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert a generic info structure to user JSON.
+| info | The generic info structure. | |
| [out] | cj | Receives the JSON object. |
| flags | The JSON format flags. |
| int onlp_generic_sw_denit | +( | +void | +) | ++ |
Deinitialize the generic software module.
+| int onlp_generic_sw_init | +( | +void | +) | ++ |
Initialize the module software module.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__oid-interfaces.html b/packages/base/any/onlp/src/onlp/doc/html/group__oid-interfaces.html
new file mode 100644
index 00000000..70dc53b0
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__oid-interfaces.html
@@ -0,0 +1,104 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Modules | |
| Attribute Interface | |
| Asset Interface | |
| ONIE Interface | |
These interfaces are available on all OIDs.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__oid-module.html b/packages/base/any/onlp/src/onlp/doc/html/group__oid-module.html
new file mode 100644
index 00000000..e975d889
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__oid-module.html
@@ -0,0 +1,388 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Data Structures | |
| struct | onlp_module_info_s |
| Module OID Information Structure. More... | |
+Typedefs | |
| +typedef struct onlp_module_info_s | onlp_module_info_t |
| Module OID Information Structure. | |
+Functions | |
| int | onlp_module_sw_init (void) |
| Initialize the module software module. More... | |
| int | onlp_module_hw_init (uint32_t flags) |
| Initialize the module. More... | |
| int | onlp_module_sw_denit (void) |
| Deinitialize the module software module. More... | |
| int | onlp_module_hdr_get (onlp_oid_t oid, onlp_oid_hdr_t *hdr) |
| Get the module header structure. More... | |
| int | onlp_module_info_get (onlp_oid_t oid, onlp_module_info_t *info) |
| Get the module info structure. More... | |
| int | onlp_module_info_to_user_json (onlp_module_info_t *info, cJSON **rv, uint32_t flags) |
| Convert a module info structure to user JSON. More... | |
| int | onlp_module_info_to_json (onlp_module_info_t *info, cJSON **rv, uint32_t flags) |
| Convert a module info structure to JSON. More... | |
| int | onlp_module_info_from_json (cJSON *cj, onlp_module_info_t *info) |
| Convert a JSON object to a module info structure. More... | |
| int onlp_module_hdr_get | +( | +onlp_oid_t | +oid, | +
| + | + | onlp_oid_hdr_t * | +hdr | +
| + | ) | ++ |
Get the module header structure.
+| oid | The Module oid. | |
| [out] | hdr | Receives the header. |
| int onlp_module_hw_init | +( | +uint32_t | +flags | ) | ++ |
Initialize the module.
+| flags | The initialization flags. |
| int onlp_module_info_from_json | +( | +cJSON * | +cj, | +
| + | + | onlp_module_info_t * | +info | +
| + | ) | ++ |
Convert a JSON object to a module info structure.
+| cj | The JSON object. | |
| [out] | info | Receives the module info structure. |
| int onlp_module_info_get | +( | +onlp_oid_t | +oid, | +
| + | + | onlp_module_info_t * | +info | +
| + | ) | ++ |
Get the module info structure.
+| oid | The Module oid. | |
| [out] | info |
| int onlp_module_info_to_json | +( | +onlp_module_info_t * | +info, | +
| + | + | cJSON ** | +rv, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert a module info structure to JSON.
+| info | The module info structure. | |
| [out] | rv | Receives the JSON object. |
| flags | The JSON format flags. |
| int onlp_module_info_to_user_json | +( | +onlp_module_info_t * | +info, | +
| + | + | cJSON ** | +rv, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert a module info structure to user JSON.
+| info | The module info structure. | |
| [out] | rv | Receives the JSON object. |
| flags | The JSON format flags. |
| int onlp_module_sw_denit | +( | +void | +) | ++ |
Deinitialize the module software module.
+| int onlp_module_sw_init | +( | +void | +) | ++ |
Initialize the module software module.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__oid-psu.html b/packages/base/any/onlp/src/onlp/doc/html/group__oid-psu.html
new file mode 100644
index 00000000..7b7bc626
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__oid-psu.html
@@ -0,0 +1,844 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Data Structures | |
| struct | onlp_psu_info_t |
+Macros | |
| #define | ONLP_PSU_INFO_CAP_IS_SET(_pinfo, _name) ((_pinfo)->caps & ONLP_PSU_CAPS_##_name) |
| #define | ONLP_PSU_STATUS_PRESENT(_pi) ( (_pi).status & ONLP_PSU_STATUS_PRESENT ) |
| #define | ONLP_PSU_STATUS_MISSING(_pi) (!ONLP_PSU_STATUS_PRESENT(_pi)) |
| #define | ONLP_PSU_STATUS_FAILED(_pi) ( (_pi).status & ONLP_PSU_STATUS_FAILED) |
| #define | ONLP_PSU_CAPS_VALID(_e) (onlp_psu_caps_valid((_e))) |
| #define | ONLP_PSU_TYPE_STRINGS |
| #define | ONLP_PSU_TYPE_VALID(_e) ( (0 <= (_e)) && ((_e) <= ONLP_PSU_TYPE_DC48)) |
+Typedefs | |
| typedef enum onlp_psu_caps_e | onlp_psu_caps_t |
| typedef enum onlp_psu_type_e | onlp_psu_type_t |
| typedef struct onlp_psu_info_t | onlp_psu_info_t |
+Enumerations | |
| enum | onlp_psu_caps_e { + ONLP_PSU_CAPS_GET_TYPE = (1 << 0), +ONLP_PSU_CAPS_GET_VIN = (1 << 1), +ONLP_PSU_CAPS_GET_VOUT = (1 << 2), +ONLP_PSU_CAPS_GET_IIN = (1 << 3), + + ONLP_PSU_CAPS_GET_IOUT = (1 << 4), +ONLP_PSU_CAPS_GET_PIN = (1 << 5), +ONLP_PSU_CAPS_GET_POUT = (1 << 6) + + } |
| enum | onlp_psu_type_e { + ONLP_PSU_TYPE_AC, +ONLP_PSU_TYPE_DC12, +ONLP_PSU_TYPE_DC48, +ONLP_PSU_TYPE_LAST = ONLP_PSU_TYPE_DC48, + + ONLP_PSU_TYPE_COUNT, +ONLP_PSU_TYPE_INVALID = -1 + + } |
+Functions | |
| +int | onlp_psu_sw_init (void) |
| Software initialization of the PSU module. | |
| int | onlp_psu_hw_init (uint32_t flags) |
| Hardware initialization of the PSU module. More... | |
| int | onlp_psu_sw_denit (void) |
| Deinitialize the psu software module. More... | |
| int | onlp_psu_hdr_get (onlp_oid_t id, onlp_oid_hdr_t *rv) |
| Get the PSU's oid header. More... | |
| int | onlp_psu_info_get (onlp_oid_t id, onlp_psu_info_t *rv) |
| Get the PSU information. More... | |
| int | onlp_psu_info_to_user_json (onlp_psu_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a PSU info structure to user JSON. More... | |
| int | onlp_psu_info_to_json (onlp_psu_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a PSU info structure to JSON. More... | |
| int | onlp_psu_info_from_json (cJSON *cj, onlp_psu_info_t *info) |
| Convert a JSON object to a PSU info structure. More... | |
| const char * | onlp_psu_caps_name (onlp_psu_caps_t e) |
| int | onlp_psu_caps_value (const char *str, onlp_psu_caps_t *e, int substr) |
| const char * | onlp_psu_caps_desc (onlp_psu_caps_t e) |
| int | onlp_psu_caps_valid (onlp_psu_caps_t e) |
| const char * | onlp_psu_type_name (onlp_psu_type_t e) |
| int | onlp_psu_type_value (const char *str, onlp_psu_type_t *e, int substr) |
| const char * | onlp_psu_type_desc (onlp_psu_type_t e) |
+Variables | |
| aim_map_si_t | onlp_psu_caps_map [] |
| aim_map_si_t | onlp_psu_caps_desc_map [] |
| aim_map_si_t | onlp_psu_type_map [] |
| aim_map_si_t | onlp_psu_type_desc_map [] |
| #define ONLP_PSU_CAPS_VALID | +( | ++ | _e | ) | +(onlp_psu_caps_valid((_e))) | +
validator
+ +| #define ONLP_PSU_INFO_CAP_IS_SET | +( | ++ | _pinfo, | +
| + | + | + | _name | +
| + | ) | +((_pinfo)->caps & ONLP_PSU_CAPS_##_name) | +
Determine if a PSU capability is set.
+ +| #define ONLP_PSU_STATUS_FAILED | +( | ++ | _pi | ) | +( (_pi).status & ONLP_PSU_STATUS_FAILED) | +
PSU has failed.
+ +| #define ONLP_PSU_STATUS_MISSING | +( | ++ | _pi | ) | +(!ONLP_PSU_STATUS_PRESENT(_pi)) | +
PSU is missing.
+ +| #define ONLP_PSU_STATUS_PRESENT | +( | ++ | _pi | ) | +( (_pi).status & ONLP_PSU_STATUS_PRESENT ) | +
PSU is present.
+ +| #define ONLP_PSU_TYPE_STRINGS | +
Strings macro.
+ +| #define ONLP_PSU_TYPE_VALID | +( | ++ | _e | ) | +( (0 <= (_e)) && ((_e) <= ONLP_PSU_TYPE_DC48)) | +
validator
+ +| typedef enum onlp_psu_caps_e onlp_psu_caps_t | +
onlp_psu_caps
+ +| typedef struct onlp_psu_info_t onlp_psu_info_t | +
PSU Information Structure
+ +| typedef enum onlp_psu_type_e onlp_psu_type_t | +
onlp_psu_type
+ +| enum onlp_psu_caps_e | +
onlp_psu_caps
+ +| enum onlp_psu_type_e | +
onlp_psu_type
+ +| const char* onlp_psu_caps_desc | +( | +onlp_psu_caps_t | +e | ) | ++ |
Enum descriptions.
+ +| const char* onlp_psu_caps_name | +( | +onlp_psu_caps_t | +e | ) | ++ |
Enum names.
+ +| int onlp_psu_caps_valid | +( | +onlp_psu_caps_t | +e | ) | ++ |
Enum validator.
+ +| int onlp_psu_caps_value | +( | +const char * | +str, | +
| + | + | onlp_psu_caps_t * | +e, | +
| + | + | int | +substr | +
| + | ) | ++ |
Enum values.
+ +| int onlp_psu_hdr_get | +( | +onlp_oid_t | +id, | +
| + | + | onlp_oid_hdr_t * | +rv | +
| + | ) | ++ |
Get the PSU's oid header.
+| id | The PSU OID. | |
| [out] | rv | Receives the header. |
| int onlp_psu_hw_init | +( | +uint32_t | +flags | ) | ++ |
Hardware initialization of the PSU module.
+| flags | The hardware initialization flags. |
| int onlp_psu_info_from_json | +( | +cJSON * | +cj, | +
| + | + | onlp_psu_info_t * | +info | +
| + | ) | ++ |
Convert a JSON object to a PSU info structure.
+| cj | The JSON object. | |
| [out] | info | Receives the PSU info structure. |
| int onlp_psu_info_get | +( | +onlp_oid_t | +id, | +
| + | + | onlp_psu_info_t * | +rv | +
| + | ) | ++ |
Get the PSU information.
+| id | The PSU OID. | |
| [out] | rv | Receives the information structure. |
| int onlp_psu_info_to_json | +( | +onlp_psu_info_t * | +info, | +
| + | + | cJSON ** | +cj, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert a PSU info structure to JSON.
+| info | The PSU info structure | |
| [out] | cj | Receives the JSON object. |
| flags | The JSON format flags. |
| int onlp_psu_info_to_user_json | +( | +onlp_psu_info_t * | +info, | +
| + | + | cJSON ** | +cj, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert a PSU info structure to user JSON.
+| info | The PSU info structure | |
| [out] | cj | Receives the JSON object. |
| flags | The JSON format flags. |
| int onlp_psu_sw_denit | +( | +void | +) | ++ |
Deinitialize the psu software module.
+| const char* onlp_psu_type_desc | +( | +onlp_psu_type_t | +e | ) | ++ |
Enum descriptions.
+ +| const char* onlp_psu_type_name | +( | +onlp_psu_type_t | +e | ) | ++ |
Enum names.
+ +| int onlp_psu_type_value | +( | +const char * | +str, | +
| + | + | onlp_psu_type_t * | +e, | +
| + | + | int | +substr | +
| + | ) | ++ |
Enum values.
+ +| aim_map_si_t onlp_psu_caps_desc_map[] | +
onlp_psu_caps_desc_map table.
+ +| aim_map_si_t onlp_psu_caps_map[] | +
onlp_psu_caps_map table.
+ +| aim_map_si_t onlp_psu_type_desc_map[] | +
onlp_psu_type_desc_map table.
+ +| aim_map_si_t onlp_psu_type_map[] | +
onlp_psu_type_map table.
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__oid-sfp.html b/packages/base/any/onlp/src/onlp/doc/html/group__oid-sfp.html
new file mode 100644
index 00000000..39ceae64
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__oid-sfp.html
@@ -0,0 +1,1777 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Data Structures | |
| struct | onlp_sfp_info_t |
+Macros | |
| #define | ONLP_SFP_BLOCK_DATA_SIZE 256 |
| #define | ONLP_SFP_CONTROL_STRINGS |
| #define | ONLP_SFP_CONTROL_VALID(_e) ( (0 <= (_e)) && ((_e) <= ONLP_SFP_CONTROL_POWER_OVERRIDE)) |
| #define | ONLP_SFP_CONTROL_FLAG_VALID(_e) (onlp_sfp_control_flag_valid((_e))) |
| #define | ONLP_SFP_TYPE_STRINGS |
| #define | ONLP_SFP_TYPE_VALID(_e) ( (0 <= (_e)) && ((_e) <= ONLP_SFP_TYPE_QSFP28)) |
+Typedefs | |
| typedef enum onlp_sfp_control_e | onlp_sfp_control_t |
| typedef enum +onlp_sfp_control_flag_e | onlp_sfp_control_flag_t |
| typedef enum onlp_sfp_type_e | onlp_sfp_type_t |
| typedef struct onlp_sfp_info_t | onlp_sfp_info_t |
| typedef aim_bitmap256_t | onlp_sfp_bitmap_t |
+Enumerations | |
| enum | onlp_sfp_control_e { + ONLP_SFP_CONTROL_RESET, +ONLP_SFP_CONTROL_RESET_STATE, +ONLP_SFP_CONTROL_RX_LOS, +ONLP_SFP_CONTROL_TX_FAULT, + + ONLP_SFP_CONTROL_TX_DISABLE, +ONLP_SFP_CONTROL_TX_DISABLE_CHANNEL, +ONLP_SFP_CONTROL_LP_MODE, +ONLP_SFP_CONTROL_POWER_OVERRIDE, + + ONLP_SFP_CONTROL_LAST = ONLP_SFP_CONTROL_POWER_OVERRIDE, +ONLP_SFP_CONTROL_COUNT, +ONLP_SFP_CONTROL_INVALID = -1 + + } |
| enum | onlp_sfp_control_flag_e { + ONLP_SFP_CONTROL_FLAG_RESET = (1 << 0), +ONLP_SFP_CONTROL_FLAG_RESET_STATE = (1 << 1), +ONLP_SFP_CONTROL_FLAG_RX_LOS = (1 << 2), +ONLP_SFP_CONTROL_FLAG_TX_FAULT = (1 << 3), + + ONLP_SFP_CONTROL_FLAG_TX_DISABLE = (1 << 4), +ONLP_SFP_CONTROL_FLAG_TX_DISABLE_CHANNEL = (1 << 5), +ONLP_SFP_CONTROL_FLAG_LP_MODE = (1 << 6), +ONLP_SFP_CONTROL_FLAG_POWER_OVERRIDE = (1 << 7) + + } |
| enum | onlp_sfp_type_e { + ONLP_SFP_TYPE_SFP, +ONLP_SFP_TYPE_QSFP, +ONLP_SFP_TYPE_SFP28, +ONLP_SFP_TYPE_QSFP28, + + ONLP_SFP_TYPE_LAST = ONLP_SFP_TYPE_QSFP28, +ONLP_SFP_TYPE_COUNT, +ONLP_SFP_TYPE_INVALID = -1 + + } |
+Functions | |
| +int | onlp_sfp_sw_init (void) |
| Software initialization of the SFP module. | |
| int | onlp_sfp_hw_init (uint32_t flags) |
| Hardware initialization of the SFP module. More... | |
| int | onlp_sfp_sw_denit (void) |
| Deinitialize the sfp software module. More... | |
| void | onlp_sfp_bitmap_t_init (onlp_sfp_bitmap_t *bmap) |
| int | onlp_sfp_bitmap_get (onlp_sfp_bitmap_t *bmap) |
| Get the set of valid SFP ports. More... | |
| int | onlp_sfp_info_get (onlp_oid_t port, onlp_sfp_info_t *info) |
| Get the SFP information structure. More... | |
| int | onlp_sfp_info_dom_get (onlp_oid_t port, onlp_sfp_info_t *info) |
| Get the SFP information structure (including DOM) More... | |
| int | onlp_sfp_hdr_get (onlp_oid_t port, onlp_oid_hdr_t *rv) |
| Get the SFP's oid header. More... | |
| int | onlp_sfp_port_valid (onlp_oid_t port) |
| Determine if a given port number is a valid SFP port. More... | |
| int | onlp_sfp_type_get (onlp_oid_t port, onlp_sfp_type_t *rtype) |
| Determine the SFP Connector type. More... | |
| int | onlp_sfp_is_present (onlp_oid_t port) |
| Determine if an SFP is currently plugged in. More... | |
| int | onlp_sfp_presence_bitmap_get (onlp_sfp_bitmap_t *dst) |
| Return the presence bitmap for all ports. More... | |
| int | onlp_sfp_rx_los_bitmap_get (onlp_sfp_bitmap_t *dst) |
| Get the RX_LOS bitmap for all ports. More... | |
| int | onlp_sfp_dev_read (onlp_oid_t port, int devaddr, int addr, uint8_t *dst, int count) |
| Read bytes from the target device on the given SFP port. More... | |
| int | onlp_sfp_dev_alloc_read (onlp_oid_t port, int devaddr, int addr, int count, uint8_t **rv) |
| Read bytes from the target device on the given SFP port. More... | |
| int | onlp_sfp_dev_write (onlp_oid_t port, int devaddr, int addr, uint8_t *src, int count) |
| Write bytes to the target device on the given SFP port. More... | |
| int | onlp_sfp_dev_readb (onlp_oid_t port, int devaddr, int addr) |
| Read a byte from the target device on the given SFP port. More... | |
| int | onlp_sfp_dev_writeb (onlp_oid_t port, int devaddr, int addr, uint8_t value) |
| Write a byte to the target device on the given SFP port. More... | |
| int | onlp_sfp_dev_readw (onlp_oid_t port, int devaddr, int addr) |
| Read a word from the target device on the given SFP port. More... | |
| int | onlp_sfp_dev_writew (onlp_oid_t port, int devaddr, int addr, uint16_t value) |
| Write a word to the target device on the given SFP port. More... | |
| int | onlp_sfp_post_insert (onlp_oid_t port, sff_info_t *info) |
| Perform any actions required after an SFP is inserted. More... | |
| int | onlp_sfp_control_set (onlp_oid_t port, onlp_sfp_control_t control, int value) |
| Set an SFP control. More... | |
| int | onlp_sfp_control_get (onlp_oid_t port, onlp_sfp_control_t control, int *value) |
| Get an SFP control. More... | |
| int | onlp_sfp_control_flags_get (onlp_oid_t port, uint32_t *flags) |
| Get the value of all SFP controls. More... | |
| int | onlp_sfp_info_to_user_json (onlp_sfp_info_t *info, cJSON **rv, uint32_t flags) |
| Convert an SFP info structure to user JSON. More... | |
| int | onlp_sfp_info_to_json (onlp_sfp_info_t *info, cJSON **rv, uint32_t flags) |
| Convert an SFP info structure to JSON. More... | |
| int | onlp_sfp_info_from_json (cJSON *cj, onlp_sfp_info_t *info) |
| Convert a JSON object to an SFP info structure. More... | |
| +int | onlp_sfp_hw_denit (void) |
| Hardware deinitialize the SFP subsystem. | |
| +int | onlp_sfp_inventory_show (aim_pvs_t *pvs) |
| Show the current SFP inventory. | |
| const char * | onlp_sfp_control_name (onlp_sfp_control_t e) |
| int | onlp_sfp_control_value (const char *str, onlp_sfp_control_t *e, int substr) |
| const char * | onlp_sfp_control_desc (onlp_sfp_control_t e) |
| const char * | onlp_sfp_control_flag_name (onlp_sfp_control_flag_t e) |
| int | onlp_sfp_control_flag_value (const char *str, onlp_sfp_control_flag_t *e, int substr) |
| const char * | onlp_sfp_control_flag_desc (onlp_sfp_control_flag_t e) |
| int | onlp_sfp_control_flag_valid (onlp_sfp_control_flag_t e) |
| const char * | onlp_sfp_type_name (onlp_sfp_type_t e) |
| int | onlp_sfp_type_value (const char *str, onlp_sfp_type_t *e, int substr) |
| const char * | onlp_sfp_type_desc (onlp_sfp_type_t e) |
+Variables | |
| aim_map_si_t | onlp_sfp_control_map [] |
| aim_map_si_t | onlp_sfp_control_desc_map [] |
| aim_map_si_t | onlp_sfp_control_flag_map [] |
| aim_map_si_t | onlp_sfp_control_flag_desc_map [] |
| aim_map_si_t | onlp_sfp_type_map [] |
| aim_map_si_t | onlp_sfp_type_desc_map [] |
| #define ONLP_SFP_BLOCK_DATA_SIZE 256 | +
SFP Block Data Size
+ +| #define ONLP_SFP_CONTROL_FLAG_VALID | +( | ++ | _e | ) | +(onlp_sfp_control_flag_valid((_e))) | +
validator
+ +| #define ONLP_SFP_CONTROL_STRINGS | +
Strings macro.
+ +| #define ONLP_SFP_CONTROL_VALID | +( | ++ | _e | ) | +( (0 <= (_e)) && ((_e) <= ONLP_SFP_CONTROL_POWER_OVERRIDE)) | +
validator
+ +| #define ONLP_SFP_TYPE_STRINGS | +
Strings macro.
+ +| #define ONLP_SFP_TYPE_VALID | +( | ++ | _e | ) | +( (0 <= (_e)) && ((_e) <= ONLP_SFP_TYPE_QSFP28)) | +
validator
+ +| typedef aim_bitmap256_t onlp_sfp_bitmap_t | +
Valid SFP Port bitmaps are communicated using this type.
+ +| typedef enum onlp_sfp_control_flag_e onlp_sfp_control_flag_t | +
onlp_sfp_control_flag
+ +| typedef enum onlp_sfp_control_e onlp_sfp_control_t | +
onlp_sfp_control
+ +| typedef struct onlp_sfp_info_t onlp_sfp_info_t | +
SFP Information Structure.
+ +| typedef enum onlp_sfp_type_e onlp_sfp_type_t | +
onlp_sfp_type
+ +| enum onlp_sfp_control_e | +
onlp_sfp_control
+ +| enum onlp_sfp_control_flag_e | +
onlp_sfp_control_flag
+ +| enum onlp_sfp_type_e | +
onlp_sfp_type
+ +| int onlp_sfp_bitmap_get | +( | +onlp_sfp_bitmap_t * | +bmap | ) | ++ |
Get the set of valid SFP ports.
+| bmap | Returns the valid set of SFP-capable port numbers. |
| void onlp_sfp_bitmap_t_init | +( | +onlp_sfp_bitmap_t * | +bmap | ) | ++ |
Convenience function for initializing SFP bitmaps.
| bmap | The address of the bitmap to initialize. |
| const char* onlp_sfp_control_desc | +( | +onlp_sfp_control_t | +e | ) | ++ |
Enum descriptions.
+ +| const char* onlp_sfp_control_flag_desc | +( | +onlp_sfp_control_flag_t | +e | ) | ++ |
Enum descriptions.
+ +| const char* onlp_sfp_control_flag_name | +( | +onlp_sfp_control_flag_t | +e | ) | ++ |
Enum names.
+ +| int onlp_sfp_control_flag_valid | +( | +onlp_sfp_control_flag_t | +e | ) | ++ |
Enum validator.
+ +| int onlp_sfp_control_flag_value | +( | +const char * | +str, | +
| + | + | onlp_sfp_control_flag_t * | +e, | +
| + | + | int | +substr | +
| + | ) | ++ |
Enum values.
+ +| int onlp_sfp_control_flags_get | +( | +onlp_oid_t | +port, | +
| + | + | uint32_t * | +flags | +
| + | ) | ++ |
Get the value of all SFP controls.
+| port | The port. |
| flags | Receives the control flag values. See onlp_sfp_control_flags_t |
| int onlp_sfp_control_get | +( | +onlp_oid_t | +port, | +
| + | + | onlp_sfp_control_t | +control, | +
| + | + | int * | +value | +
| + | ) | ++ |
Get an SFP control.
+| port | The SFP Port ID. | |
| control | The control | |
| [out] | value | Receives the current value. |
| const char* onlp_sfp_control_name | +( | +onlp_sfp_control_t | +e | ) | ++ |
Enum names.
+ +| int onlp_sfp_control_set | +( | +onlp_oid_t | +port, | +
| + | + | onlp_sfp_control_t | +control, | +
| + | + | int | +value | +
| + | ) | ++ |
Set an SFP control.
+| port | The SFP Port ID. |
| control | The control. |
| value | The value. |
| int onlp_sfp_control_value | +( | +const char * | +str, | +
| + | + | onlp_sfp_control_t * | +e, | +
| + | + | int | +substr | +
| + | ) | ++ |
Enum values.
+ +| int onlp_sfp_dev_alloc_read | +( | +onlp_oid_t | +port, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr, | +
| + | + | int | +count, | +
| + | + | uint8_t ** | +rv | +
| + | ) | ++ |
Read bytes from the target device on the given SFP port.
+| port | The SFP OID or Port ID. | |
| devaddr | The device address. | |
| addr | The start target address. | |
| count | The number of bytes to read. | |
| [out] | rv | Receives the allocated buffer. |
| int onlp_sfp_dev_read | +( | +onlp_oid_t | +port, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr, | +
| + | + | uint8_t * | +dst, | +
| + | + | int | +count | +
| + | ) | ++ |
Read bytes from the target device on the given SFP port.
+| port | The SFP OID or Port ID. |
| devaddr | The device address. |
| addr | The address to read. |
| dst | Receives the data. |
| count | The read length. |
| int onlp_sfp_dev_readb | +( | +onlp_oid_t | +port, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr | +
| + | ) | ++ |
Read a byte from the target device on the given SFP port.
+| port | The SFP Port ID. |
| devaddr | The device address. |
| addr | The read address. |
| int onlp_sfp_dev_readw | +( | +onlp_oid_t | +port, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr | +
| + | ) | ++ |
Read a word from the target device on the given SFP port.
+| port | The SFP Port ID. |
| devaddr | The device address. |
| addr | The read address. |
| int onlp_sfp_dev_write | +( | +onlp_oid_t | +port, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr, | +
| + | + | uint8_t * | +src, | +
| + | + | int | +count | +
| + | ) | ++ |
Write bytes to the target device on the given SFP port.
+| port | The SFP OID or Port ID. |
| devaddr | The device address. |
| addr | The address to write. |
| src | The source data. |
| count | The write length. |
| int onlp_sfp_dev_writeb | +( | +onlp_oid_t | +port, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr, | +
| + | + | uint8_t | +value | +
| + | ) | ++ |
Write a byte to the target device on the given SFP port.
+| port | The SFP Port ID. |
| devaddr | The device address. |
| addr | The write address. |
| value | The write value. |
| int onlp_sfp_dev_writew | +( | +onlp_oid_t | +port, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr, | +
| + | + | uint16_t | +value | +
| + | ) | ++ |
Write a word to the target device on the given SFP port.
+| port | The SFP Port ID. |
| devaddr | The device address. |
| addr | The write address. |
| value | The write value. |
| int onlp_sfp_hdr_get | +( | +onlp_oid_t | +port, | +
| + | + | onlp_oid_hdr_t * | +rv | +
| + | ) | ++ |
Get the SFP's oid header.
+| port | The SFP OID. | |
| [out] | rv | Receives the header. |
| int onlp_sfp_hw_init | +( | +uint32_t | +flags | ) | ++ |
Hardware initialization of the SFP module.
+| flags | The hardware initialization flags. |
| int onlp_sfp_info_dom_get | +( | +onlp_oid_t | +port, | +
| + | + | onlp_sfp_info_t * | +info | +
| + | ) | ++ |
Get the SFP information structure (including DOM)
+| port | The SFP OID or Port ID. | |
| [out] | info | Receives the information structure. |
| int onlp_sfp_info_from_json | +( | +cJSON * | +cj, | +
| + | + | onlp_sfp_info_t * | +info | +
| + | ) | ++ |
Convert a JSON object to an SFP info structure.
+| cj | The JSON object. | |
| [out] | info | Receives the SFP info structure. |
| int onlp_sfp_info_get | +( | +onlp_oid_t | +port, | +
| + | + | onlp_sfp_info_t * | +info | +
| + | ) | ++ |
Get the SFP information structure.
+| port | The SFP OID or Port ID. | |
| [out] | info | Receives the information structure. |
| int onlp_sfp_info_to_json | +( | +onlp_sfp_info_t * | +info, | +
| + | + | cJSON ** | +rv, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert an SFP info structure to JSON.
+| info | The SFP info structure. | |
| [out] | rv | Receives the JSON object. |
| flags | The JSON format flags. |
| int onlp_sfp_info_to_user_json | +( | +onlp_sfp_info_t * | +info, | +
| + | + | cJSON ** | +rv, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert an SFP info structure to user JSON.
+| info | The SFP info structure. | |
| [out] | rv | Receives the JSON object. |
| flags | The JSON format flags. |
| int onlp_sfp_is_present | +( | +onlp_oid_t | +port | ) | ++ |
Determine if an SFP is currently plugged in.
+| port | The SFP port number. |
| int onlp_sfp_port_valid | +( | +onlp_oid_t | +port | ) | ++ |
Determine if a given port number is a valid SFP port.
+| port | The port number. |
| int onlp_sfp_post_insert | +( | +onlp_oid_t | +port, | +
| + | + | sff_info_t * | +info | +
| + | ) | ++ |
Perform any actions required after an SFP is inserted.
+| port | The SFP Port ID. |
| info | The SFF Module information structure. |
| int onlp_sfp_presence_bitmap_get | +( | +onlp_sfp_bitmap_t * | +dst | ) | ++ |
Return the presence bitmap for all ports.
+| dst | The receives the presence bitmap for all ports. |
| int onlp_sfp_rx_los_bitmap_get | +( | +onlp_sfp_bitmap_t * | +dst | ) | ++ |
Get the RX_LOS bitmap for all ports.
+| dst | Receives the RX_LOS bitmap for all ports. |
| int onlp_sfp_sw_denit | +( | +void | +) | ++ |
Deinitialize the sfp software module.
+Software deinitialize the SFP subsystem.
+| const char* onlp_sfp_type_desc | +( | +onlp_sfp_type_t | +e | ) | ++ |
Enum descriptions.
+ +| int onlp_sfp_type_get | +( | +onlp_oid_t | +port, | +
| + | + | onlp_sfp_type_t * | +rtype | +
| + | ) | ++ |
Determine the SFP Connector type.
+| port | The port number. | |
| [out] | rtype | Receives the type. |
| const char* onlp_sfp_type_name | +( | +onlp_sfp_type_t | +e | ) | ++ |
Enum names.
+ +| int onlp_sfp_type_value | +( | +const char * | +str, | +
| + | + | onlp_sfp_type_t * | +e, | +
| + | + | int | +substr | +
| + | ) | ++ |
Enum values.
+ +| aim_map_si_t onlp_sfp_control_desc_map[] | +
onlp_sfp_control_desc_map table.
+ +| aim_map_si_t onlp_sfp_control_flag_desc_map[] | +
onlp_sfp_control_flag_desc_map table.
+ +| aim_map_si_t onlp_sfp_control_flag_map[] | +
onlp_sfp_control_flag_map table.
+ +| aim_map_si_t onlp_sfp_control_map[] | +
onlp_sfp_control_map table.
+ +| aim_map_si_t onlp_sfp_type_desc_map[] | +
onlp_sfp_type_desc_map table.
+ +| aim_map_si_t onlp_sfp_type_map[] | +
onlp_sfp_type_map table.
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__oid-thermal.html b/packages/base/any/onlp/src/onlp/doc/html/group__oid-thermal.html
new file mode 100644
index 00000000..33221c72
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__oid-thermal.html
@@ -0,0 +1,827 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Data Structures | |
| struct | onlp_thermal_info_s |
+Macros | |
| #define | ONLP_THERMAL_CAPS_ALL 0xF |
| #define | ONLP_THERMAL_CAPS_GET_ANY_THRESHOLD |
| #define | ONLP_THERMAL_THRESHOLD_INIT_DEFAULTS |
| #define | ONLP_THERMAL_INFO_CAP_IS_SET(_pinfo, _name) ((_pinfo)->caps & ONLP_THERMAL_CAPS_##_name) |
| #define | ONLP_THERMAL_CAPS_VALID(_e) (onlp_thermal_caps_valid((_e))) |
| #define | ONLP_THERMAL_THRESHOLD_VALID(_e) (onlp_thermal_threshold_valid((_e))) |
+Typedefs | |
| typedef enum onlp_thermal_caps_e | onlp_thermal_caps_t |
| typedef enum +onlp_thermal_threshold_e | onlp_thermal_threshold_t |
| typedef struct onlp_thermal_info_s | onlp_thermal_info_t |
+Enumerations | |
| enum | onlp_thermal_caps_e { ONLP_THERMAL_CAPS_GET_TEMPERATURE = (1 << 0), +ONLP_THERMAL_CAPS_GET_WARNING_THRESHOLD = (1 << 1), +ONLP_THERMAL_CAPS_GET_ERROR_THRESHOLD = (1 << 2), +ONLP_THERMAL_CAPS_GET_SHUTDOWN_THRESHOLD = (1 << 3) + } |
| enum | onlp_thermal_threshold_e { ONLP_THERMAL_THRESHOLD_WARNING_DEFAULT = 45000, +ONLP_THERMAL_THRESHOLD_ERROR_DEFAULT = 55000, +ONLP_THERMAL_THRESHOLD_SHUTDOWN_DEFAULT = 60000 + } |
+Functions | |
| +int | onlp_thermal_sw_init (void) |
| Software initialization of the thermal module. | |
| int | onlp_thermal_hw_init (uint32_t flags) |
| Hardware initialization of the thermal module. More... | |
| int | onlp_thermal_sw_denit (void) |
| Deinitialize the thermal software module. More... | |
| int | onlp_thermal_hdr_get (onlp_oid_t oid, onlp_oid_hdr_t *rv) |
| Retrieve the thermal's oid header. More... | |
| int | onlp_thermal_info_get (onlp_oid_t oid, onlp_thermal_info_t *rv) |
| Retrieve information about the given thermal id. More... | |
| int | onlp_thermal_info_to_json (onlp_thermal_info_t *info, cJSON **rv, uint32_t flags) |
| Convert a thermal info structure to json. More... | |
| int | onlp_thermal_info_from_json (cJSON *cj, onlp_thermal_info_t *info) |
| Convert a JSON object to a thermal info structure. More... | |
| int | onlp_thermal_info_to_user_json (onlp_thermal_info_t *info, cJSON **rv, uint32_t flags) |
| Convert a thermal info structure to user json. More... | |
| const char * | onlp_thermal_caps_name (onlp_thermal_caps_t e) |
| int | onlp_thermal_caps_value (const char *str, onlp_thermal_caps_t *e, int substr) |
| const char * | onlp_thermal_caps_desc (onlp_thermal_caps_t e) |
| int | onlp_thermal_caps_valid (onlp_thermal_caps_t e) |
| const char * | onlp_thermal_threshold_name (onlp_thermal_threshold_t e) |
| int | onlp_thermal_threshold_value (const char *str, onlp_thermal_threshold_t *e, int substr) |
| const char * | onlp_thermal_threshold_desc (onlp_thermal_threshold_t e) |
| int | onlp_thermal_threshold_valid (onlp_thermal_threshold_t e) |
+Variables | |
| aim_map_si_t | onlp_thermal_caps_map [] |
| aim_map_si_t | onlp_thermal_caps_desc_map [] |
| aim_map_si_t | onlp_thermal_threshold_map [] |
| aim_map_si_t | onlp_thermal_threshold_desc_map [] |
| #define ONLP_THERMAL_CAPS_ALL 0xF | +
Shortcut for specifying all capabilties.
+ +| #define ONLP_THERMAL_CAPS_GET_ANY_THRESHOLD | +
Shortcut for determining the availability of any threshold value.
+ +| #define ONLP_THERMAL_CAPS_VALID | +( | ++ | _e | ) | +(onlp_thermal_caps_valid((_e))) | +
validator
+ +| #define ONLP_THERMAL_INFO_CAP_IS_SET | +( | ++ | _pinfo, | +
| + | + | + | _name | +
| + | ) | +((_pinfo)->caps & ONLP_THERMAL_CAPS_##_name) | +
Determine if a thermal capability is set.
+ +| #define ONLP_THERMAL_THRESHOLD_INIT_DEFAULTS | +
Shortcut for all default thermal threshold value.
+ +| #define ONLP_THERMAL_THRESHOLD_VALID | +( | ++ | _e | ) | +(onlp_thermal_threshold_valid((_e))) | +
validator
+ +| typedef enum onlp_thermal_caps_e onlp_thermal_caps_t | +
onlp_thermal_caps
+ +| typedef struct onlp_thermal_info_s onlp_thermal_info_t | +
Thermal sensor information structure.
+ +| typedef enum onlp_thermal_threshold_e onlp_thermal_threshold_t | +
onlp_thermal_threshold
+ +| enum onlp_thermal_caps_e | +
onlp_thermal_caps
+ +| enum onlp_thermal_threshold_e | +
onlp_thermal_threshold
+ +| const char* onlp_thermal_caps_desc | +( | +onlp_thermal_caps_t | +e | ) | ++ |
Enum descriptions.
+ +| const char* onlp_thermal_caps_name | +( | +onlp_thermal_caps_t | +e | ) | ++ |
Enum names.
+ +| int onlp_thermal_caps_valid | +( | +onlp_thermal_caps_t | +e | ) | ++ |
Enum validator.
+ +| int onlp_thermal_caps_value | +( | +const char * | +str, | +
| + | + | onlp_thermal_caps_t * | +e, | +
| + | + | int | +substr | +
| + | ) | ++ |
Enum values.
+ +| int onlp_thermal_hdr_get | +( | +onlp_oid_t | +oid, | +
| + | + | onlp_oid_hdr_t * | +rv | +
| + | ) | ++ |
Retrieve the thermal's oid header.
+| oid | The thermal oid. | |
| [out] | rv | Receives the header. |
| int onlp_thermal_hw_init | +( | +uint32_t | +flags | ) | ++ |
Hardware initialization of the thermal module.
+| flags | The hardware initialization flags. |
| int onlp_thermal_info_from_json | +( | +cJSON * | +cj, | +
| + | + | onlp_thermal_info_t * | +info | +
| + | ) | ++ |
Convert a JSON object to a thermal info structure.
+| cj | The JSON object representing the structure. | |
| [out] | info | Receives the thermal info. |
| int onlp_thermal_info_get | +( | +onlp_oid_t | +oid, | +
| + | + | onlp_thermal_info_t * | +rv | +
| + | ) | ++ |
Retrieve information about the given thermal id.
+| oid | The thermal oid. | |
| [out] | rv | Receives the thermal information. |
| int onlp_thermal_info_to_json | +( | +onlp_thermal_info_t * | +info, | +
| + | + | cJSON ** | +rv, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert a thermal info structure to json.
+| info | The thermal info structure. | |
| [out] | rv | Receives the JSON object. |
| flags | The JSON processing flags. |
| int onlp_thermal_info_to_user_json | +( | +onlp_thermal_info_t * | +info, | +
| + | + | cJSON ** | +rv, | +
| + | + | uint32_t | +flags | +
| + | ) | ++ |
Convert a thermal info structure to user json.
+| info | The thermal info structure. | |
| [out] | rv | Receives the JSON object. |
| flags | The JSON processing flags. |
| int onlp_thermal_sw_denit | +( | +void | +) | ++ |
Deinitialize the thermal software module.
+| const char* onlp_thermal_threshold_desc | +( | +onlp_thermal_threshold_t | +e | ) | ++ |
Enum descriptions.
+ +| const char* onlp_thermal_threshold_name | +( | +onlp_thermal_threshold_t | +e | ) | ++ |
Enum names.
+ +| int onlp_thermal_threshold_valid | +( | +onlp_thermal_threshold_t | +e | ) | ++ |
Enum validator.
+ +| int onlp_thermal_threshold_value | +( | +const char * | +str, | +
| + | + | onlp_thermal_threshold_t * | +e, | +
| + | + | int | +substr | +
| + | ) | ++ |
Enum values.
+ +| aim_map_si_t onlp_thermal_caps_desc_map[] | +
onlp_thermal_caps_desc_map table.
+ +| aim_map_si_t onlp_thermal_caps_map[] | +
onlp_thermal_caps_map table.
+ +| aim_map_si_t onlp_thermal_threshold_desc_map[] | +
onlp_thermal_threshold_desc_map table.
+ +| aim_map_si_t onlp_thermal_threshold_map[] | +
onlp_thermal_threshold_map table.
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__oid-types.html b/packages/base/any/onlp/src/onlp/doc/html/group__oid-types.html
new file mode 100644
index 00000000..73897be5
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__oid-types.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Modules | |
| Chassis | |
| Modules | |
| Thermals | |
| Fans | |
| PSUs | |
| SFPs | |
| Generics | |
Software interfaces by OID Type.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__onie.html b/packages/base/any/onlp/src/onlp/doc/html/group__onie.html
new file mode 100644
index 00000000..931e39ab
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__onie.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__onlp-appication.html b/packages/base/any/onlp/src/onlp/doc/html/group__onlp-appication.html
new file mode 100644
index 00000000..def9c372
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__onlp-appication.html
@@ -0,0 +1,101 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__onlp-config.html b/packages/base/any/onlp/src/onlp/doc/html/group__onlp-config.html
new file mode 100644
index 00000000..a6d627b7
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__onlp-config.html
@@ -0,0 +1,524 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Data Structures | |
| struct | onlp_config_settings_s |
+Macros | |
| #define | ONLP_CONFIG_INCLUDE_LOGGING 1 |
| #define | ONLP_CONFIG_LOG_OPTIONS_DEFAULT AIM_LOG_OPTIONS_DEFAULT |
| #define | ONLP_CONFIG_LOG_BITS_DEFAULT AIM_LOG_BITS_DEFAULT |
| #define | ONLP_CONFIG_LOG_CUSTOM_BITS_DEFAULT 0 |
| #define | ONLP_CONFIG_PORTING_STDLIB 1 |
| #define | ONLP_CONFIG_PORTING_INCLUDE_STDLIB_HEADERS ONLP_CONFIG_PORTING_STDLIB |
| #define | ONLP_CONFIG_INCLUDE_UCLI 0 |
| #define | ONLP_CONFIG_INCLUDE_PLATFORM_ERROR_CHECK 1 |
| #define | ONLP_CONFIG_INCLUDE_SHLOCK_GLOBAL_INIT 0 |
| #define | ONLP_CONFIG_PLATFORM_NAME NULL |
| #define | ONLP_CONFIG_PLATFORM_FILENAME "/etc/onl/platform" |
| #define | ONLP_CONFIG_INCLUDE_PLATFORM_OVERRIDES 1 |
| #define | ONLP_CONFIG_CONFIGURATION_FILENAME "/etc/onlp.conf" |
| #define | ONLP_CONFIG_CONFIGURATION_ENV "ONLP_CONF" |
| #define | ONLP_CONFIG_INCLUDE_API_LOCK 1 |
| #define | ONLP_CONFIG_API_LOCK_GLOBAL_SHARED 1 |
| #define | ONLP_CONFIG_API_LOCK_TIMEOUT 60000000 |
| #define | ONLP_CONFIG_INFO_STR_MAX 64 |
| #define | ONLP_CONFIG_INCLUDE_THERMAL_THRESHOLDS 0 |
| #define | ONLP_CONFIG_INCLUDE_API_PROFILING 0 |
+Typedefs | |
| typedef struct +onlp_config_settings_s | onlp_config_settings_t |
+Functions | |
| const char * | onlp_config_lookup (const char *setting) |
| Lookup a configuration setting. More... | |
| int | onlp_config_show (struct aim_pvs_s *pvs) |
| Show the compile-time configuration. More... | |
+Variables | |
| onlp_config_settings_t | onlp_config_settings [] |
| #define ONLP_CONFIG_API_LOCK_GLOBAL_SHARED 1 | +
ONLP_CONFIG_API_LOCK_GLOBAL_SHARED
+If 0, the API lock is a simple semaphore. If 1, the API lock is a global shared mutex.
+ +| #define ONLP_CONFIG_API_LOCK_TIMEOUT 60000000 | +
ONLP_CONFIG_API_LOCK_TIMEOUT
+The maximum amount of time (in usecs) to wait while attempting to acquire the API lock. Failure to acquire is fatal. A value of zero disables this feature.
+ +| #define ONLP_CONFIG_CONFIGURATION_ENV "ONLP_CONF" | +
ONLP_CONFIG_CONFIGURATION_ENV
+Environment variable to check for configuration filenames. Overrides default.
+ +| #define ONLP_CONFIG_CONFIGURATION_FILENAME "/etc/onlp.conf" | +
ONLP_CONFIG_CONFIGURATION_FILENAME
+The filename for the (optional) ONLP JSON configuration file.
+ +| #define ONLP_CONFIG_INCLUDE_API_LOCK 1 | +
ONLP_CONFIG_INCLUDE_API_LOCK
+Include exclusive locking for all API calls.
+ +| #define ONLP_CONFIG_INCLUDE_API_PROFILING 0 | +
ONLP_CONFIG_INCLUDE_API_PROFILING
+Include API timing profiles.
+ +| #define ONLP_CONFIG_INCLUDE_LOGGING 1 | +
ONLP_CONFIG_INCLUDE_LOGGING
+Include or exclude logging.
+ +| #define ONLP_CONFIG_INCLUDE_PLATFORM_ERROR_CHECK 1 | +
ONLP_CONFIG_INCLUDE_PLATFORM_ERROR_CHECK
+Include platform error checking at initialization.
+ +| #define ONLP_CONFIG_INCLUDE_PLATFORM_OVERRIDES 1 | +
ONLP_CONFIG_INCLUDE_PLATFORM_OVERRIDES
+Allow support for local overrides of all platform OID values (testing).
+ +| #define ONLP_CONFIG_INCLUDE_SHLOCK_GLOBAL_INIT 0 | +
ONLP_CONFIG_INCLUDE_SHLOCK_GLOBAL_INIT
+Include global shlock initialization at module init time.
+ +| #define ONLP_CONFIG_INCLUDE_THERMAL_THRESHOLDS 0 | +
ONLP_CONFIG_INCLUDE_THERMAL_THRESHOLDS
+Include thermal threshold reporting.
+ +| #define ONLP_CONFIG_INCLUDE_UCLI 0 | +
ONLP_CONFIG_INCLUDE_UCLI
+Include generic uCli support.
+ +| #define ONLP_CONFIG_INFO_STR_MAX 64 | +
ONLP_CONFIG_INFO_STR_MAX
+The maximum size of static information string buffers.
+ +| #define ONLP_CONFIG_LOG_BITS_DEFAULT AIM_LOG_BITS_DEFAULT | +
ONLP_CONFIG_LOG_BITS_DEFAULT
+Default enabled log bits.
+ +| #define ONLP_CONFIG_LOG_CUSTOM_BITS_DEFAULT 0 | +
ONLP_CONFIG_LOG_CUSTOM_BITS_DEFAULT
+Default enabled custom log bits.
+ +| #define ONLP_CONFIG_LOG_OPTIONS_DEFAULT AIM_LOG_OPTIONS_DEFAULT | +
ONLP_CONFIG_LOG_OPTIONS_DEFAULT
+Default enabled log options.
+ +| #define ONLP_CONFIG_PLATFORM_FILENAME "/etc/onl/platform" | +
ONLP_CONFIG_PLATFORM_FILENAME
+The local filename containing the current platform identifier.
+ +| #define ONLP_CONFIG_PLATFORM_NAME NULL | +
ONLP_CONFIG_PLATFORM_NAME
+Static platform configuration.
+ +| #define ONLP_CONFIG_PORTING_INCLUDE_STDLIB_HEADERS ONLP_CONFIG_PORTING_STDLIB | +
ONLP_CONFIG_PORTING_INCLUDE_STDLIB_HEADERS
+Include standard library headers for stdlib porting macros.
+ +| #define ONLP_CONFIG_PORTING_STDLIB 1 | +
ONLP_CONFIG_PORTING_STDLIB
+Default all porting macros to use the C standard libraries.
+ +| typedef struct onlp_config_settings_s onlp_config_settings_t | +
All compile time options can be queried or displayedConfiguration settings structure.
+ +| const char* onlp_config_lookup | +( | +const char * | +setting | ) | ++ |
Lookup a configuration setting.
+| setting | The name of the configuration option to lookup. |
| int onlp_config_show | +( | +struct aim_pvs_s * | +pvs | ) | ++ |
Show the compile-time configuration.
+| pvs | The output stream. |
| onlp_config_settings_t onlp_config_settings[] | +
Configuration settings table. onlp_config_settings table.
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__onlp-main.html b/packages/base/any/onlp/src/onlp/doc/html/group__onlp-main.html
new file mode 100644
index 00000000..c01ac3db
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__onlp-main.html
@@ -0,0 +1,103 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Modules | |
| ONLP Application Interfaces | |
| Platform Implementation Interfaces | |
| Module Documentation | |
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__onlp-platform.html b/packages/base/any/onlp/src/onlp/doc/html/group__onlp-platform.html
new file mode 100644
index 00000000..1ccd363f
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__onlp-platform.html
@@ -0,0 +1,110 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Modules | |
| Chassis | |
| Modules | |
| Thermals | |
| Fans | |
| PSUs | |
| SFPs | |
These document the requires for implementing the platform interfaces.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__onlp-porting.html b/packages/base/any/onlp/src/onlp/doc/html/group__onlp-porting.html
new file mode 100644
index 00000000..b7c1ee19
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__onlp-porting.html
@@ -0,0 +1,90 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__psui.html b/packages/base/any/onlp/src/onlp/doc/html/group__psui.html
new file mode 100644
index 00000000..1ba94b2e
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__psui.html
@@ -0,0 +1,270 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Macros | |
| #define | ONLP_CHASSIS_PSU_INFO_ENTRY_INIT(_id, _desc) |
| Initialize a static PSU info structure. More... | |
+Functions | |
| +int | onlp_psui_sw_init (void) |
| Software initialization of the PSU module. | |
| int | onlp_psui_hw_init (uint32_t flags) |
| Hardware initialization of the PSU module. More... | |
| int | onlp_psui_sw_denit (void) |
| Deinitialize the psu software module. More... | |
| int | onlp_psui_hdr_get (onlp_oid_id_t id, onlp_oid_hdr_t *rv) |
| Get the PSU's oid header. More... | |
| int | onlp_psui_info_get (onlp_oid_id_t id, onlp_psu_info_t *rv) |
| Get the information structure for the given PSU. More... | |
| #define ONLP_CHASSIS_PSU_INFO_ENTRY_INIT | +( | ++ | _id, | +
| + | + | + | _desc | +
| + | ) | ++ |
Initialize a static PSU info structure.
+ +| int onlp_psui_hdr_get | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_oid_hdr_t * | +rv | +
| + | ) | ++ |
Get the PSU's oid header.
+| id | The PSU OID. | |
| [out] | rv | Receives the header. |
| int onlp_psui_hw_init | +( | +uint32_t | +flags | ) | ++ |
Hardware initialization of the PSU module.
+| flags | The hardware initialization flags. |
| int onlp_psui_info_get | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_psu_info_t * | +rv | +
| + | ) | ++ |
Get the information structure for the given PSU.
+| id | The PSU OID | |
| [out] | rv | Receives the PSU information. |
| int onlp_psui_sw_denit | +( | +void | +) | ++ |
Deinitialize the psu software module.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__sfpi.html b/packages/base/any/onlp/src/onlp/doc/html/group__sfpi.html
new file mode 100644
index 00000000..0f2f2802
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__sfpi.html
@@ -0,0 +1,869 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Functions | |
| +int | onlp_sfpi_sw_init (void) |
| Software initialization of the SFP module. | |
| int | onlp_sfpi_hw_init (uint32_t flags) |
| Hardware initialization of the SFP module. More... | |
| int | onlp_sfpi_sw_denit (void) |
| Deinitialize the chassis software module. More... | |
| int | onlp_sfpi_bitmap_get (onlp_sfp_bitmap_t *bmap) |
| Get the bitmap of SFP-capable port numbers. More... | |
| int | onlp_sfpi_type_get (onlp_oid_id_t id, onlp_sfp_type_t *rtype) |
| Determine the SFP connector type. More... | |
| int | onlp_sfpi_is_present (onlp_oid_id_t id) |
| Determine if an SFP is present. More... | |
| int | onlp_sfpi_presence_bitmap_get (onlp_sfp_bitmap_t *dst) |
| Return the presence bitmap for all SFP ports. More... | |
| int | onlp_sfpi_rx_los_bitmap_get (onlp_sfp_bitmap_t *dst) |
| Return the RX_LOS bitmap for all SFP ports. More... | |
| int | onlp_sfpi_dev_read (onlp_oid_id_t id, int devaddr, int addr, uint8_t *dst, int len) |
| Read bytes from the target device on the given SFP port. More... | |
| int | onlp_sfpi_dev_write (onlp_oid_id_t id, int devaddr, int addr, uint8_t *src, int len) |
| Write bytes to the target device on the given SFP port. More... | |
| int | onlp_sfpi_dev_readb (onlp_oid_id_t id, int devaddr, int addr) |
| Read a byte from the target device on the given SFP port. More... | |
| int | onlp_sfpi_dev_writeb (onlp_oid_id_t id, int devaddr, int addr, uint8_t value) |
| Write a byte to the target device on the given SFP port. More... | |
| int | onlp_sfpi_dev_readw (onlp_oid_id_t id, int devaddr, int addr) |
| Read a word from the target device on the given SFP port. More... | |
| int | onlp_sfpi_dev_writew (onlp_oid_id_t id, int devaddr, int addr, uint16_t value) |
| Write a word to the target device on the given SFP port. More... | |
| int | onlp_sfpi_post_insert (onlp_oid_id_t id, sff_info_t *info) |
| Perform any actions required after an SFP is inserted. More... | |
| int | onlp_sfpi_control_supported (onlp_oid_id_t id, onlp_sfp_control_t control, int *rv) |
| Returns whether or not the given control is supported on the given port. More... | |
| int | onlp_sfpi_control_set (onlp_oid_id_t id, onlp_sfp_control_t control, int value) |
| Set an SFP control. More... | |
| int | onlp_sfpi_control_get (onlp_oid_id_t id, onlp_sfp_control_t control, int *value) |
| Get an SFP control. More... | |
| int | onlp_sfpi_port_map (onlp_oid_id_t id, int *rport) |
| Remap SFP user SFP port numbers before calling the SFPI interface. More... | |
| int | onlp_sfpi_hdr_get (onlp_oid_id_t id, onlp_oid_hdr_t *hdr) |
| Get the SFP's OID header. More... | |
| int onlp_sfpi_bitmap_get | +( | +onlp_sfp_bitmap_t * | +bmap | ) | ++ |
Get the bitmap of SFP-capable port numbers.
+| [out] | bmap | Receives the bitmap. |
| int onlp_sfpi_control_get | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_sfp_control_t | +control, | +
| + | + | int * | +value | +
| + | ) | ++ |
Get an SFP control.
+| id | The SFP Port ID. | |
| control | The control | |
| [out] | value | Receives the current value. |
| int onlp_sfpi_control_set | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_sfp_control_t | +control, | +
| + | + | int | +value | +
| + | ) | ++ |
Set an SFP control.
+| id | The SFP Port ID. |
| control | The control. |
| value | The value. |
| int onlp_sfpi_control_supported | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_sfp_control_t | +control, | +
| + | + | int * | +rv | +
| + | ) | ++ |
Returns whether or not the given control is supported on the given port.
+| id | The SFP Port ID. | |
| control | The control. | |
| [out] | rv | Receives 1 if supported, 0 if not supported. |
| int onlp_sfpi_dev_read | +( | +onlp_oid_id_t | +id, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr, | +
| + | + | uint8_t * | +dst, | +
| + | + | int | +len | +
| + | ) | ++ |
Read bytes from the target device on the given SFP port.
+| id | The SFP Port ID. | |
| devaddr | The device address. | |
| addr | Read offset. | |
| [out] | dst | Receives the data. |
| len | Read length. |
| int onlp_sfpi_dev_readb | +( | +onlp_oid_id_t | +id, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr | +
| + | ) | ++ |
Read a byte from the target device on the given SFP port.
+| id | The SFP Port ID. |
| devaddr | The device address. |
| addr | The read address. |
| int onlp_sfpi_dev_readw | +( | +onlp_oid_id_t | +id, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr | +
| + | ) | ++ |
Read a word from the target device on the given SFP port.
+| id | The SFP Port ID. |
| devaddr | The device address. |
| addr | The read address. |
| int onlp_sfpi_dev_write | +( | +onlp_oid_id_t | +id, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr, | +
| + | + | uint8_t * | +src, | +
| + | + | int | +len | +
| + | ) | ++ |
Write bytes to the target device on the given SFP port.
+| id | The SFP Port ID. |
| devaddr | The device address. |
| addr | Write offset. |
| src | The bytes to write. |
| len | Write length. |
| int onlp_sfpi_dev_writeb | +( | +onlp_oid_id_t | +id, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr, | +
| + | + | uint8_t | +value | +
| + | ) | ++ |
Write a byte to the target device on the given SFP port.
+| id | The SFP Port ID. |
| devaddr | The device address. |
| addr | The write address. |
| value | The write value. |
| int onlp_sfpi_dev_writew | +( | +onlp_oid_id_t | +id, | +
| + | + | int | +devaddr, | +
| + | + | int | +addr, | +
| + | + | uint16_t | +value | +
| + | ) | ++ |
Write a word to the target device on the given SFP port.
+| id | The SFP Port ID. |
| devaddr | The device address. |
| addr | The write address. |
| value | The write value. |
| int onlp_sfpi_hdr_get | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_oid_hdr_t * | +hdr | +
| + | ) | ++ |
Get the SFP's OID header.
+| id | The SFP oid. | |
| [out] | hdr | Receives the header. |
| int onlp_sfpi_hw_init | +( | +uint32_t | +flags | ) | ++ |
Hardware initialization of the SFP module.
+| flags | The hardware initialization flags. |
| int onlp_sfpi_is_present | +( | +onlp_oid_id_t | +id | ) | ++ |
Determine if an SFP is present.
+| id | The SFP Port ID. |
| int onlp_sfpi_port_map | +( | +onlp_oid_id_t | +id, | +
| + | + | int * | +rport | +
| + | ) | ++ |
Remap SFP user SFP port numbers before calling the SFPI interface.
+| id | The SFP Port ID. | |
| [out] | rport | Receives the new port. |
| int onlp_sfpi_post_insert | +( | +onlp_oid_id_t | +id, | +
| + | + | sff_info_t * | +info | +
| + | ) | ++ |
Perform any actions required after an SFP is inserted.
+| id | The SFP Port ID. |
| info | The SFF Module information structure. |
| int onlp_sfpi_presence_bitmap_get | +( | +onlp_sfp_bitmap_t * | +dst | ) | ++ |
Return the presence bitmap for all SFP ports.
+| [out] | dst | Receives the presence bitmap. |
| int onlp_sfpi_rx_los_bitmap_get | +( | +onlp_sfp_bitmap_t * | +dst | ) | ++ |
Return the RX_LOS bitmap for all SFP ports.
+| [out] | dst | Receives the RX_LOS bitmap. |
| int onlp_sfpi_sw_denit | +( | +void | +) | ++ |
Deinitialize the chassis software module.
+| int onlp_sfpi_type_get | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_sfp_type_t * | +rtype | +
| + | ) | ++ |
Determine the SFP connector type.
+| id | The SFP Port ID. | |
| [out] | rtype | Receives the connector type. |
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__stdattrs.html b/packages/base/any/onlp/src/onlp/doc/html/group__stdattrs.html
new file mode 100644
index 00000000..84c5ac4d
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__stdattrs.html
@@ -0,0 +1,124 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Data Structures | |
| struct | onlp_asset_info_s |
| This structure describes general asset information that may be associated with a particular OID. More... | |
+Typedefs | |
| +typedef struct onlp_asset_info_s | onlp_asset_info_t |
| This structure describes general asset information that may be associated with a particular OID. | |
+Functions | |
| +int | onlp_asset_info_show (onlp_asset_info_t *aip, aim_pvs_t *pvs) |
| Show an asset structure. | |
| +int | onlp_asset_info_free (onlp_asset_info_t *aip) |
| Free an asset structure. | |
| +int | onlp_asset_info_to_json (onlp_asset_info_t *aip, cJSON **rv) |
| Asset info to JSON. | |
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/group__thermali.html b/packages/base/any/onlp/src/onlp/doc/html/group__thermali.html
new file mode 100644
index 00000000..5ad63f19
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/group__thermali.html
@@ -0,0 +1,341 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+Macros | |
| #define | ONLP_THERMAL_INFO_ENTRY_INIT(_id, _desc, _parent) |
| #define | ONLP_CHASSIS_THERMAL_INFO_ENTRY_INIT(_id, _desc) ONLP_THERMAL_INFO_ENTRY_INIT(_id, _desc, ONLP_OID_CHASSIS) |
| #define | ONLP_PSU_THERMAL_INFO_ENTRY_INIT(_id, _desc, _psu_id) ONLP_THERMAL_INFO_ENTRY_INIT(_id, _desc, ONLP_PSU_ID_CREATE(_psu_id)) |
+Functions | |
| +int | onlp_thermali_sw_init (void) |
| Software initialization of the Thermal module. | |
| int | onlp_thermali_hw_init (uint32_t flags) |
| Hardware initialization of the Thermal module. More... | |
| int | onlp_thermali_sw_denit (void) |
| Deinitialize the thermal software module. More... | |
| int | onlp_thermali_hdr_get (onlp_oid_id_t id, onlp_oid_hdr_t *rv) |
| Retrieve the thermal's oid header. More... | |
| int | onlp_thermali_info_get (onlp_oid_id_t id, onlp_thermal_info_t *rv) |
| Get the information for the given thermal OID. More... | |
| #define ONLP_CHASSIS_THERMAL_INFO_ENTRY_INIT | +( | ++ | _id, | +
| + | + | + | _desc | +
| + | ) | +ONLP_THERMAL_INFO_ENTRY_INIT(_id, _desc, ONLP_OID_CHASSIS) | +
This macro should be used to statically initialize a chassis thermal info structure.
+ +| #define ONLP_PSU_THERMAL_INFO_ENTRY_INIT | +( | ++ | _id, | +
| + | + | + | _desc, | +
| + | + | + | _psu_id | +
| + | ) | +ONLP_THERMAL_INFO_ENTRY_INIT(_id, _desc, ONLP_PSU_ID_CREATE(_psu_id)) | +
This macro should be used to statically initialize a PSU thermal info structure.
+ +| #define ONLP_THERMAL_INFO_ENTRY_INIT | +( | ++ | _id, | +
| + | + | + | _desc, | +
| + | + | + | _parent | +
| + | ) | ++ |
This macro should be used in your implementation to declare your static chassis thermal sensors.
+ +| int onlp_thermali_hdr_get | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_oid_hdr_t * | +rv | +
| + | ) | ++ |
Retrieve the thermal's oid header.
+| id | The thermal oid. | |
| [out] | rv | Receives the header. |
| int onlp_thermali_hw_init | +( | +uint32_t | +flags | ) | ++ |
Hardware initialization of the Thermal module.
+| flags | The hardware initialization flags. |
| int onlp_thermali_info_get | +( | +onlp_oid_id_t | +id, | +
| + | + | onlp_thermal_info_t * | +rv | +
| + | ) | ++ |
Get the information for the given thermal OID.
+| id | The Thermal OID | |
| [out] | rv | Receives the thermal information. |
| int onlp_thermali_sw_denit | +( | +void | +) | ++ |
Deinitialize the thermal software module.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/index.html b/packages/base/any/onlp/src/onlp/doc/html/index.html
new file mode 100644
index 00000000..65e67050
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/index.html
@@ -0,0 +1,97 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/jquery.js b/packages/base/any/onlp/src/onlp/doc/html/jquery.js
new file mode 100644
index 00000000..92dbb494
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/jquery.js
@@ -0,0 +1,31 @@
+/*
+ * jQuery JavaScript Library v1.7.1
+ * http://jquery.com/
+ *
+ * Copyright 2011, John Resig
+ * Dual licensed under the MIT or GPL Version 2 licenses.
+ * http://jquery.org/license
+ *
+ * Includes Sizzle.js
+ * http://sizzlejs.com/
+ * Copyright 2011, The Dojo Foundation
+ * Released under the MIT, BSD, and GPL Licenses.
+ *
+ * Date: Mon Nov 21 21:11:03 2011 -0500
+ */
+(function(bb,L){var av=bb.document,bu=bb.navigator,bl=bb.location;var b=(function(){var bF=function(b0,b1){return new bF.fn.init(b0,b1,bD)},bU=bb.jQuery,bH=bb.$,bD,bY=/^(?:[^#<]*(<[\w\W]+>)[^>]*$|#([\w\-]*)$)/,bM=/\S/,bI=/^\s+/,bE=/\s+$/,bA=/^<(\w+)\s*\/?>(?:<\/\1>)?$/,bN=/^[\],:{}\s]*$/,bW=/\\(?:["\\\/bfnrt]|u[0-9a-fA-F]{4})/g,bP=/"[^"\\\n\r]*"|true|false|null|-?\d+(?:\.\d*)?(?:[eE][+\-]?\d+)?/g,bJ=/(?:^|:|,)(?:\s*\[)+/g,by=/(webkit)[ \/]([\w.]+)/,bR=/(opera)(?:.*version)?[ \/]([\w.]+)/,bQ=/(msie) ([\w.]+)/,bS=/(mozilla)(?:.*? rv:([\w.]+))?/,bB=/-([a-z]|[0-9])/ig,bZ=/^-ms-/,bT=function(b0,b1){return(b1+"").toUpperCase()},bX=bu.userAgent,bV,bC,e,bL=Object.prototype.toString,bG=Object.prototype.hasOwnProperty,bz=Array.prototype.push,bK=Array.prototype.slice,bO=String.prototype.trim,bv=Array.prototype.indexOf,bx={};bF.fn=bF.prototype={constructor:bF,init:function(b0,b4,b3){var b2,b5,b1,b6;if(!b0){return this}if(b0.nodeType){this.context=this[0]=b0;this.length=1;return this}if(b0==="body"&&!b4&&av.body){this.context=av;this[0]=av.body;this.selector=b0;this.length=1;return this}if(typeof b0==="string"){if(b0.charAt(0)==="<"&&b0.charAt(b0.length-1)===">"&&b0.length>=3){b2=[null,b0,null]}else{b2=bY.exec(b0)}if(b2&&(b2[1]||!b4)){if(b2[1]){b4=b4 instanceof bF?b4[0]:b4;b6=(b4?b4.ownerDocument||b4:av);b1=bA.exec(b0);if(b1){if(bF.isPlainObject(b4)){b0=[av.createElement(b1[1])];bF.fn.attr.call(b0,b4,true)}else{b0=[b6.createElement(b1[1])]}}else{b1=bF.buildFragment([b2[1]],[b6]);b0=(b1.cacheable?bF.clone(b1.fragment):b1.fragment).childNodes}return bF.merge(this,b0)}else{b5=av.getElementById(b2[2]);if(b5&&b5.parentNode){if(b5.id!==b2[2]){return b3.find(b0)}this.length=1;this[0]=b5}this.context=av;this.selector=b0;return this}}else{if(!b4||b4.jquery){return(b4||b3).find(b0)}else{return this.constructor(b4).find(b0)}}}else{if(bF.isFunction(b0)){return b3.ready(b0)}}if(b0.selector!==L){this.selector=b0.selector;this.context=b0.context}return bF.makeArray(b0,this)},selector:"",jquery:"1.7.1",length:0,size:function(){return this.length},toArray:function(){return bK.call(this,0)},get:function(b0){return b0==null?this.toArray():(b0<0?this[this.length+b0]:this[b0])},pushStack:function(b1,b3,b0){var b2=this.constructor();if(bF.isArray(b1)){bz.apply(b2,b1)}else{bF.merge(b2,b1)}b2.prevObject=this;b2.context=this.context;if(b3==="find"){b2.selector=this.selector+(this.selector?" ":"")+b0}else{if(b3){b2.selector=this.selector+"."+b3+"("+b0+")"}}return b2},each:function(b1,b0){return bF.each(this,b1,b0)},ready:function(b0){bF.bindReady();bC.add(b0);return this},eq:function(b0){b0=+b0;return b0===-1?this.slice(b0):this.slice(b0,b0+1)},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},slice:function(){return this.pushStack(bK.apply(this,arguments),"slice",bK.call(arguments).join(","))},map:function(b0){return this.pushStack(bF.map(this,function(b2,b1){return b0.call(b2,b1,b2)}))},end:function(){return this.prevObject||this.constructor(null)},push:bz,sort:[].sort,splice:[].splice};bF.fn.init.prototype=bF.fn;bF.extend=bF.fn.extend=function(){var b9,b2,b0,b1,b6,b7,b5=arguments[0]||{},b4=1,b3=arguments.length,b8=false;if(typeof b5==="boolean"){b8=b5;b5=arguments[1]||{};b4=2}if(typeof b5!=="object"&&!bF.isFunction(b5)){b5={}}if(b3===b4){b5=this;--b4}for(;b4| t |
|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/ledi_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/ledi_8h_source.html
new file mode 100644
index 00000000..fd0554d5
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/ledi_8h_source.html
@@ -0,0 +1,163 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/module_8h.html b/packages/base/any/onlp/src/onlp/doc/html/module_8h.html
new file mode 100644
index 00000000..e95a4810
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/module_8h.html
@@ -0,0 +1,157 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Module OID Interface. +More...
+#include <onlp/onlp_config.h>#include <onlp/onlp.h>#include <onlplib/onie.h>#include <onlplib/pi.h>#include <onlp/oids.h>Go to the source code of this file.
++Data Structures | |
| struct | onlp_module_info_s |
| Module OID Information Structure. More... | |
+Typedefs | |
| +typedef struct onlp_module_info_s | onlp_module_info_t |
| Module OID Information Structure. | |
+Functions | |
| int | onlp_module_sw_init (void) |
| Initialize the module software module. More... | |
| int | onlp_module_hw_init (uint32_t flags) |
| Initialize the module. More... | |
| int | onlp_module_sw_denit (void) |
| Deinitialize the module software module. More... | |
| int | onlp_module_hdr_get (onlp_oid_t oid, onlp_oid_hdr_t *hdr) |
| Get the module header structure. More... | |
| int | onlp_module_info_get (onlp_oid_t oid, onlp_module_info_t *info) |
| Get the module info structure. More... | |
| int | onlp_module_info_to_user_json (onlp_module_info_t *info, cJSON **rv, uint32_t flags) |
| Convert a module info structure to user JSON. More... | |
| int | onlp_module_info_to_json (onlp_module_info_t *info, cJSON **rv, uint32_t flags) |
| Convert a module info structure to JSON. More... | |
| int | onlp_module_info_from_json (cJSON *cj, onlp_module_info_t *info) |
| Convert a JSON object to a module info structure. More... | |
Module OID Interface.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/module_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/module_8h_source.html
new file mode 100644
index 00000000..a33cd53f
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/module_8h_source.html
@@ -0,0 +1,167 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/modules.html b/packages/base/any/onlp/src/onlp/doc/html/modules.html
new file mode 100644
index 00000000..8b92e3d0
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/modules.html
@@ -0,0 +1,119 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
| ▼ONLP | |
| ▼ONLP Application Interfaces | |
| ▼General OID Interfaces | |
| Attribute Interface | |
| Asset Interface | |
| ONIE Interface | |
| ▼OID Types | |
| Chassis | |
| Modules | |
| Thermals | |
| Fans | |
| PSUs | |
| SFPs | |
| Generics | |
| ▼Platform Implementation Interfaces | |
| Chassis | |
| Modules | |
| Thermals | |
| Fans | |
| PSUs | |
| SFPs | |
| ▼Module Documentation | |
| Compile Time Configuration | |
| Porting Macros | |
| Stdattrs |
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/nav_f.png b/packages/base/any/onlp/src/onlp/doc/html/nav_f.png
new file mode 100644
index 00000000..72a58a52
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/nav_f.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/nav_g.png b/packages/base/any/onlp/src/onlp/doc/html/nav_g.png
new file mode 100644
index 00000000..2093a237
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/nav_g.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/nav_h.png b/packages/base/any/onlp/src/onlp/doc/html/nav_h.png
new file mode 100644
index 00000000..33389b10
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/nav_h.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/oids_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/oids_8h_source.html
new file mode 100644
index 00000000..f0767fc4
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/oids_8h_source.html
@@ -0,0 +1,436 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/onlp_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/onlp_8h_source.html
new file mode 100644
index 00000000..31452cac
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/onlp_8h_source.html
@@ -0,0 +1,217 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/onlp__config_8h.html b/packages/base/any/onlp/src/onlp/doc/html/onlp__config_8h.html
new file mode 100644
index 00000000..d237de70
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/onlp__config_8h.html
@@ -0,0 +1,184 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
onlp Configuration Header +More...
+ +Go to the source code of this file.
++Data Structures | |
| struct | onlp_config_settings_s |
+Macros | |
| #define | ONLP_CONFIG_INCLUDE_LOGGING 1 |
| #define | ONLP_CONFIG_LOG_OPTIONS_DEFAULT AIM_LOG_OPTIONS_DEFAULT |
| #define | ONLP_CONFIG_LOG_BITS_DEFAULT AIM_LOG_BITS_DEFAULT |
| #define | ONLP_CONFIG_LOG_CUSTOM_BITS_DEFAULT 0 |
| #define | ONLP_CONFIG_PORTING_STDLIB 1 |
| #define | ONLP_CONFIG_PORTING_INCLUDE_STDLIB_HEADERS ONLP_CONFIG_PORTING_STDLIB |
| #define | ONLP_CONFIG_INCLUDE_UCLI 0 |
| #define | ONLP_CONFIG_INCLUDE_PLATFORM_ERROR_CHECK 1 |
| #define | ONLP_CONFIG_INCLUDE_SHLOCK_GLOBAL_INIT 0 |
| #define | ONLP_CONFIG_PLATFORM_NAME NULL |
| #define | ONLP_CONFIG_PLATFORM_FILENAME "/etc/onl/platform" |
| #define | ONLP_CONFIG_INCLUDE_PLATFORM_OVERRIDES 1 |
| #define | ONLP_CONFIG_CONFIGURATION_FILENAME "/etc/onlp.conf" |
| #define | ONLP_CONFIG_CONFIGURATION_ENV "ONLP_CONF" |
| #define | ONLP_CONFIG_INCLUDE_API_LOCK 1 |
| #define | ONLP_CONFIG_API_LOCK_GLOBAL_SHARED 1 |
| #define | ONLP_CONFIG_API_LOCK_TIMEOUT 60000000 |
| #define | ONLP_CONFIG_INFO_STR_MAX 64 |
| #define | ONLP_CONFIG_INCLUDE_THERMAL_THRESHOLDS 0 |
| #define | ONLP_CONFIG_INCLUDE_API_PROFILING 0 |
+Typedefs | |
| typedef struct +onlp_config_settings_s | onlp_config_settings_t |
+Functions | |
| const char * | onlp_config_lookup (const char *setting) |
| Lookup a configuration setting. More... | |
| int | onlp_config_show (struct aim_pvs_s *pvs) |
| Show the compile-time configuration. More... | |
+Variables | |
| onlp_config_settings_t | onlp_config_settings [] |
onlp Configuration Header
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/onlp__config_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/onlp__config_8h_source.html
new file mode 100644
index 00000000..76dd8120
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/onlp__config_8h_source.html
@@ -0,0 +1,239 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/onlp__dox_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/onlp__dox_8h_source.html
new file mode 100644
index 00000000..76f9addc
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/onlp__dox_8h_source.html
@@ -0,0 +1,128 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/onlp__porting_8h.html b/packages/base/any/onlp/src/onlp/doc/html/onlp__porting_8h.html
new file mode 100644
index 00000000..815d73c1
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/onlp__porting_8h.html
@@ -0,0 +1,112 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
onlp Porting Macros. +More...
+#include <stdio.h>#include <stdlib.h>#include <string.h>#include <stdarg.h>#include <memory.h>Go to the source code of this file.
+onlp Porting Macros.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/onlp__porting_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/onlp__porting_8h_source.html
new file mode 100644
index 00000000..ad8c5c34
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/onlp__porting_8h_source.html
@@ -0,0 +1,184 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/open.png b/packages/base/any/onlp/src/onlp/doc/html/open.png
new file mode 100644
index 00000000..30f75c7e
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/open.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/platform_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/platform_8h_source.html
new file mode 100644
index 00000000..dbba5e0e
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/platform_8h_source.html
@@ -0,0 +1,132 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/platformi_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/platformi_8h_source.html
new file mode 100644
index 00000000..db82b279
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/platformi_8h_source.html
@@ -0,0 +1,145 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/psu_8h.html b/packages/base/any/onlp/src/onlp/doc/html/psu_8h.html
new file mode 100644
index 00000000..3d593353
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/psu_8h.html
@@ -0,0 +1,227 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Power Supply Management. +More...
+#include <onlp/onlp.h>#include <onlp/oids.h>Go to the source code of this file.
++Data Structures | |
| struct | onlp_psu_info_t |
+Macros | |
| #define | ONLP_PSU_INFO_CAP_IS_SET(_pinfo, _name) ((_pinfo)->caps & ONLP_PSU_CAPS_##_name) |
| #define | ONLP_PSU_STATUS_PRESENT(_pi) ( (_pi).status & ONLP_PSU_STATUS_PRESENT ) |
| #define | ONLP_PSU_STATUS_MISSING(_pi) (!ONLP_PSU_STATUS_PRESENT(_pi)) |
| #define | ONLP_PSU_STATUS_FAILED(_pi) ( (_pi).status & ONLP_PSU_STATUS_FAILED) |
| #define | ONLP_PSU_CAPS_VALID(_e) (onlp_psu_caps_valid((_e))) |
| #define | ONLP_PSU_TYPE_STRINGS |
| #define | ONLP_PSU_TYPE_VALID(_e) ( (0 <= (_e)) && ((_e) <= ONLP_PSU_TYPE_DC48)) |
+Typedefs | |
| typedef enum onlp_psu_caps_e | onlp_psu_caps_t |
| typedef enum onlp_psu_type_e | onlp_psu_type_t |
| typedef struct onlp_psu_info_t | onlp_psu_info_t |
+Enumerations | |
| enum | onlp_psu_caps_e { + ONLP_PSU_CAPS_GET_TYPE = (1 << 0), +ONLP_PSU_CAPS_GET_VIN = (1 << 1), +ONLP_PSU_CAPS_GET_VOUT = (1 << 2), +ONLP_PSU_CAPS_GET_IIN = (1 << 3), + + ONLP_PSU_CAPS_GET_IOUT = (1 << 4), +ONLP_PSU_CAPS_GET_PIN = (1 << 5), +ONLP_PSU_CAPS_GET_POUT = (1 << 6) + + } |
| enum | onlp_psu_type_e { + ONLP_PSU_TYPE_AC, +ONLP_PSU_TYPE_DC12, +ONLP_PSU_TYPE_DC48, +ONLP_PSU_TYPE_LAST = ONLP_PSU_TYPE_DC48, + + ONLP_PSU_TYPE_COUNT, +ONLP_PSU_TYPE_INVALID = -1 + + } |
+Functions | |
| +int | onlp_psu_sw_init (void) |
| Software initialization of the PSU module. | |
| int | onlp_psu_hw_init (uint32_t flags) |
| Hardware initialization of the PSU module. More... | |
| int | onlp_psu_sw_denit (void) |
| Deinitialize the psu software module. More... | |
| int | onlp_psu_hdr_get (onlp_oid_t id, onlp_oid_hdr_t *rv) |
| Get the PSU's oid header. More... | |
| int | onlp_psu_info_get (onlp_oid_t id, onlp_psu_info_t *rv) |
| Get the PSU information. More... | |
| int | onlp_psu_info_to_user_json (onlp_psu_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a PSU info structure to user JSON. More... | |
| int | onlp_psu_info_to_json (onlp_psu_info_t *info, cJSON **cj, uint32_t flags) |
| Convert a PSU info structure to JSON. More... | |
| int | onlp_psu_info_from_json (cJSON *cj, onlp_psu_info_t *info) |
| Convert a JSON object to a PSU info structure. More... | |
| const char * | onlp_psu_caps_name (onlp_psu_caps_t e) |
| int | onlp_psu_caps_value (const char *str, onlp_psu_caps_t *e, int substr) |
| const char * | onlp_psu_caps_desc (onlp_psu_caps_t e) |
| int | onlp_psu_caps_valid (onlp_psu_caps_t e) |
| const char * | onlp_psu_type_name (onlp_psu_type_t e) |
| int | onlp_psu_type_value (const char *str, onlp_psu_type_t *e, int substr) |
| const char * | onlp_psu_type_desc (onlp_psu_type_t e) |
+Variables | |
| aim_map_si_t | onlp_psu_caps_map [] |
| aim_map_si_t | onlp_psu_caps_desc_map [] |
| aim_map_si_t | onlp_psu_type_map [] |
| aim_map_si_t | onlp_psu_type_desc_map [] |
Power Supply Management.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/psu_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/psu_8h_source.html
new file mode 100644
index 00000000..d363e4f8
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/psu_8h_source.html
@@ -0,0 +1,284 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/psui_8h.html b/packages/base/any/onlp/src/onlp/doc/html/psui_8h.html
new file mode 100644
index 00000000..0561d79a
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/psui_8h.html
@@ -0,0 +1,137 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Power Supply Management Implementation. +More...
+#include <onlp/psu.h>Go to the source code of this file.
++Macros | |
| #define | ONLP_CHASSIS_PSU_INFO_ENTRY_INIT(_id, _desc) |
| Initialize a static PSU info structure. More... | |
+Functions | |
| +int | onlp_psui_sw_init (void) |
| Software initialization of the PSU module. | |
| int | onlp_psui_hw_init (uint32_t flags) |
| Hardware initialization of the PSU module. More... | |
| int | onlp_psui_sw_denit (void) |
| Deinitialize the psu software module. More... | |
| int | onlp_psui_hdr_get (onlp_oid_id_t id, onlp_oid_hdr_t *rv) |
| Get the PSU's oid header. More... | |
| int | onlp_psui_info_get (onlp_oid_id_t id, onlp_psu_info_t *rv) |
| Get the information structure for the given PSU. More... | |
Power Supply Management Implementation.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/psui_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/psui_8h_source.html
new file mode 100644
index 00000000..04178234
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/psui_8h_source.html
@@ -0,0 +1,155 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/search/all_0.html b/packages/base/any/onlp/src/onlp/doc/html/search/all_0.html
new file mode 100644
index 00000000..6f4ddc39
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/search/all_0.html
@@ -0,0 +1,26 @@
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
SFP Management Interface. +More...
+#include <onlp/onlp_config.h>#include <onlp/onlp.h>#include <onlp/oids.h>#include <AIM/aim_bitmap.h>#include <AIM/aim_pvs.h>#include <sff/sff.h>#include <sff/dom.h>Go to the source code of this file.
++Data Structures | |
| struct | onlp_sfp_info_t |
+Macros | |
| #define | ONLP_SFP_BLOCK_DATA_SIZE 256 |
| #define | ONLP_SFP_CONTROL_STRINGS |
| #define | ONLP_SFP_CONTROL_VALID(_e) ( (0 <= (_e)) && ((_e) <= ONLP_SFP_CONTROL_POWER_OVERRIDE)) |
| #define | ONLP_SFP_CONTROL_FLAG_VALID(_e) (onlp_sfp_control_flag_valid((_e))) |
| #define | ONLP_SFP_TYPE_STRINGS |
| #define | ONLP_SFP_TYPE_VALID(_e) ( (0 <= (_e)) && ((_e) <= ONLP_SFP_TYPE_QSFP28)) |
+Typedefs | |
| typedef enum onlp_sfp_control_e | onlp_sfp_control_t |
| typedef enum +onlp_sfp_control_flag_e | onlp_sfp_control_flag_t |
| typedef enum onlp_sfp_type_e | onlp_sfp_type_t |
| typedef struct onlp_sfp_info_t | onlp_sfp_info_t |
| typedef aim_bitmap256_t | onlp_sfp_bitmap_t |
+Enumerations | |
| enum | onlp_sfp_control_e { + ONLP_SFP_CONTROL_RESET, +ONLP_SFP_CONTROL_RESET_STATE, +ONLP_SFP_CONTROL_RX_LOS, +ONLP_SFP_CONTROL_TX_FAULT, + + ONLP_SFP_CONTROL_TX_DISABLE, +ONLP_SFP_CONTROL_TX_DISABLE_CHANNEL, +ONLP_SFP_CONTROL_LP_MODE, +ONLP_SFP_CONTROL_POWER_OVERRIDE, + + ONLP_SFP_CONTROL_LAST = ONLP_SFP_CONTROL_POWER_OVERRIDE, +ONLP_SFP_CONTROL_COUNT, +ONLP_SFP_CONTROL_INVALID = -1 + + } |
| enum | onlp_sfp_control_flag_e { + ONLP_SFP_CONTROL_FLAG_RESET = (1 << 0), +ONLP_SFP_CONTROL_FLAG_RESET_STATE = (1 << 1), +ONLP_SFP_CONTROL_FLAG_RX_LOS = (1 << 2), +ONLP_SFP_CONTROL_FLAG_TX_FAULT = (1 << 3), + + ONLP_SFP_CONTROL_FLAG_TX_DISABLE = (1 << 4), +ONLP_SFP_CONTROL_FLAG_TX_DISABLE_CHANNEL = (1 << 5), +ONLP_SFP_CONTROL_FLAG_LP_MODE = (1 << 6), +ONLP_SFP_CONTROL_FLAG_POWER_OVERRIDE = (1 << 7) + + } |
| enum | onlp_sfp_type_e { + ONLP_SFP_TYPE_SFP, +ONLP_SFP_TYPE_QSFP, +ONLP_SFP_TYPE_SFP28, +ONLP_SFP_TYPE_QSFP28, + + ONLP_SFP_TYPE_LAST = ONLP_SFP_TYPE_QSFP28, +ONLP_SFP_TYPE_COUNT, +ONLP_SFP_TYPE_INVALID = -1 + + } |
+Functions | |
| +int | onlp_sfp_sw_init (void) |
| Software initialization of the SFP module. | |
| int | onlp_sfp_hw_init (uint32_t flags) |
| Hardware initialization of the SFP module. More... | |
| int | onlp_sfp_sw_denit (void) |
| Deinitialize the sfp software module. More... | |
| void | onlp_sfp_bitmap_t_init (onlp_sfp_bitmap_t *bmap) |
| int | onlp_sfp_bitmap_get (onlp_sfp_bitmap_t *bmap) |
| Get the set of valid SFP ports. More... | |
| int | onlp_sfp_info_get (onlp_oid_t port, onlp_sfp_info_t *info) |
| Get the SFP information structure. More... | |
| int | onlp_sfp_info_dom_get (onlp_oid_t port, onlp_sfp_info_t *info) |
| Get the SFP information structure (including DOM) More... | |
| int | onlp_sfp_hdr_get (onlp_oid_t port, onlp_oid_hdr_t *rv) |
| Get the SFP's oid header. More... | |
| int | onlp_sfp_port_valid (onlp_oid_t port) |
| Determine if a given port number is a valid SFP port. More... | |
| int | onlp_sfp_type_get (onlp_oid_t port, onlp_sfp_type_t *rtype) |
| Determine the SFP Connector type. More... | |
| int | onlp_sfp_is_present (onlp_oid_t port) |
| Determine if an SFP is currently plugged in. More... | |
| int | onlp_sfp_presence_bitmap_get (onlp_sfp_bitmap_t *dst) |
| Return the presence bitmap for all ports. More... | |
| int | onlp_sfp_rx_los_bitmap_get (onlp_sfp_bitmap_t *dst) |
| Get the RX_LOS bitmap for all ports. More... | |
| int | onlp_sfp_dev_read (onlp_oid_t port, int devaddr, int addr, uint8_t *dst, int count) |
| Read bytes from the target device on the given SFP port. More... | |
| int | onlp_sfp_dev_alloc_read (onlp_oid_t port, int devaddr, int addr, int count, uint8_t **rv) |
| Read bytes from the target device on the given SFP port. More... | |
| int | onlp_sfp_dev_write (onlp_oid_t port, int devaddr, int addr, uint8_t *src, int count) |
| Write bytes to the target device on the given SFP port. More... | |
| int | onlp_sfp_dev_readb (onlp_oid_t port, int devaddr, int addr) |
| Read a byte from the target device on the given SFP port. More... | |
| int | onlp_sfp_dev_writeb (onlp_oid_t port, int devaddr, int addr, uint8_t value) |
| Write a byte to the target device on the given SFP port. More... | |
| int | onlp_sfp_dev_readw (onlp_oid_t port, int devaddr, int addr) |
| Read a word from the target device on the given SFP port. More... | |
| int | onlp_sfp_dev_writew (onlp_oid_t port, int devaddr, int addr, uint16_t value) |
| Write a word to the target device on the given SFP port. More... | |
| int | onlp_sfp_post_insert (onlp_oid_t port, sff_info_t *info) |
| Perform any actions required after an SFP is inserted. More... | |
| int | onlp_sfp_control_set (onlp_oid_t port, onlp_sfp_control_t control, int value) |
| Set an SFP control. More... | |
| int | onlp_sfp_control_get (onlp_oid_t port, onlp_sfp_control_t control, int *value) |
| Get an SFP control. More... | |
| int | onlp_sfp_control_flags_get (onlp_oid_t port, uint32_t *flags) |
| Get the value of all SFP controls. More... | |
| int | onlp_sfp_info_to_user_json (onlp_sfp_info_t *info, cJSON **rv, uint32_t flags) |
| Convert an SFP info structure to user JSON. More... | |
| int | onlp_sfp_info_to_json (onlp_sfp_info_t *info, cJSON **rv, uint32_t flags) |
| Convert an SFP info structure to JSON. More... | |
| int | onlp_sfp_info_from_json (cJSON *cj, onlp_sfp_info_t *info) |
| Convert a JSON object to an SFP info structure. More... | |
| +int | onlp_sfp_hw_denit (void) |
| Hardware deinitialize the SFP subsystem. | |
| +int | onlp_sfp_inventory_show (aim_pvs_t *pvs) |
| Show the current SFP inventory. | |
| const char * | onlp_sfp_control_name (onlp_sfp_control_t e) |
| int | onlp_sfp_control_value (const char *str, onlp_sfp_control_t *e, int substr) |
| const char * | onlp_sfp_control_desc (onlp_sfp_control_t e) |
| const char * | onlp_sfp_control_flag_name (onlp_sfp_control_flag_t e) |
| int | onlp_sfp_control_flag_value (const char *str, onlp_sfp_control_flag_t *e, int substr) |
| const char * | onlp_sfp_control_flag_desc (onlp_sfp_control_flag_t e) |
| int | onlp_sfp_control_flag_valid (onlp_sfp_control_flag_t e) |
| const char * | onlp_sfp_type_name (onlp_sfp_type_t e) |
| int | onlp_sfp_type_value (const char *str, onlp_sfp_type_t *e, int substr) |
| const char * | onlp_sfp_type_desc (onlp_sfp_type_t e) |
+Variables | |
| aim_map_si_t | onlp_sfp_control_map [] |
| aim_map_si_t | onlp_sfp_control_desc_map [] |
| aim_map_si_t | onlp_sfp_control_flag_map [] |
| aim_map_si_t | onlp_sfp_control_flag_desc_map [] |
| aim_map_si_t | onlp_sfp_type_map [] |
| aim_map_si_t | onlp_sfp_type_desc_map [] |
SFP Management Interface.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/sfp_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/sfp_8h_source.html
new file mode 100644
index 00000000..28630969
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/sfp_8h_source.html
@@ -0,0 +1,412 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/sfpi_8h.html b/packages/base/any/onlp/src/onlp/doc/html/sfpi_8h.html
new file mode 100644
index 00000000..c8f6f69d
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/sfpi_8h.html
@@ -0,0 +1,177 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
SFP Platform Implementation Interface. This interface must be implemented and available for all platforms that support SFP interfaces. +More...
+ +Go to the source code of this file.
++Functions | |
| +int | onlp_sfpi_sw_init (void) |
| Software initialization of the SFP module. | |
| int | onlp_sfpi_hw_init (uint32_t flags) |
| Hardware initialization of the SFP module. More... | |
| int | onlp_sfpi_sw_denit (void) |
| Deinitialize the chassis software module. More... | |
| int | onlp_sfpi_bitmap_get (onlp_sfp_bitmap_t *bmap) |
| Get the bitmap of SFP-capable port numbers. More... | |
| int | onlp_sfpi_type_get (onlp_oid_id_t id, onlp_sfp_type_t *rtype) |
| Determine the SFP connector type. More... | |
| int | onlp_sfpi_is_present (onlp_oid_id_t id) |
| Determine if an SFP is present. More... | |
| int | onlp_sfpi_presence_bitmap_get (onlp_sfp_bitmap_t *dst) |
| Return the presence bitmap for all SFP ports. More... | |
| int | onlp_sfpi_rx_los_bitmap_get (onlp_sfp_bitmap_t *dst) |
| Return the RX_LOS bitmap for all SFP ports. More... | |
| int | onlp_sfpi_dev_read (onlp_oid_id_t id, int devaddr, int addr, uint8_t *dst, int len) |
| Read bytes from the target device on the given SFP port. More... | |
| int | onlp_sfpi_dev_write (onlp_oid_id_t id, int devaddr, int addr, uint8_t *src, int len) |
| Write bytes to the target device on the given SFP port. More... | |
| int | onlp_sfpi_dev_readb (onlp_oid_id_t id, int devaddr, int addr) |
| Read a byte from the target device on the given SFP port. More... | |
| int | onlp_sfpi_dev_writeb (onlp_oid_id_t id, int devaddr, int addr, uint8_t value) |
| Write a byte to the target device on the given SFP port. More... | |
| int | onlp_sfpi_dev_readw (onlp_oid_id_t id, int devaddr, int addr) |
| Read a word from the target device on the given SFP port. More... | |
| int | onlp_sfpi_dev_writew (onlp_oid_id_t id, int devaddr, int addr, uint16_t value) |
| Write a word to the target device on the given SFP port. More... | |
| int | onlp_sfpi_post_insert (onlp_oid_id_t id, sff_info_t *info) |
| Perform any actions required after an SFP is inserted. More... | |
| int | onlp_sfpi_control_supported (onlp_oid_id_t id, onlp_sfp_control_t control, int *rv) |
| Returns whether or not the given control is supported on the given port. More... | |
| int | onlp_sfpi_control_set (onlp_oid_id_t id, onlp_sfp_control_t control, int value) |
| Set an SFP control. More... | |
| int | onlp_sfpi_control_get (onlp_oid_id_t id, onlp_sfp_control_t control, int *value) |
| Get an SFP control. More... | |
| int | onlp_sfpi_port_map (onlp_oid_id_t id, int *rport) |
| Remap SFP user SFP port numbers before calling the SFPI interface. More... | |
| int | onlp_sfpi_hdr_get (onlp_oid_id_t id, onlp_oid_hdr_t *hdr) |
| Get the SFP's OID header. More... | |
SFP Platform Implementation Interface. This interface must be implemented and available for all platforms that support SFP interfaces.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/sfpi_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/sfpi_8h_source.html
new file mode 100644
index 00000000..38858071
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/sfpi_8h_source.html
@@ -0,0 +1,206 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/stdattrs_8h.html b/packages/base/any/onlp/src/onlp/doc/html/stdattrs_8h.html
new file mode 100644
index 00000000..d17405bc
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/stdattrs_8h.html
@@ -0,0 +1,143 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Standard OID Attributes. +More...
+#include <onlp/oids.h>#include <onlplib/onie.h>#include <AIM/aim_pvs.h>Go to the source code of this file.
++Data Structures | |
| struct | onlp_asset_info_s |
| This structure describes general asset information that may be associated with a particular OID. More... | |
+Typedefs | |
| +typedef struct onlp_asset_info_s | onlp_asset_info_t |
| This structure describes general asset information that may be associated with a particular OID. | |
+Functions | |
| +int | onlp_asset_info_show (onlp_asset_info_t *aip, aim_pvs_t *pvs) |
| Show an asset structure. | |
| +int | onlp_asset_info_free (onlp_asset_info_t *aip) |
| Free an asset structure. | |
| +int | onlp_asset_info_to_json (onlp_asset_info_t *aip, cJSON **rv) |
| Asset info to JSON. | |
Standard OID Attributes.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/stdattrs_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/stdattrs_8h_source.html
new file mode 100644
index 00000000..390ea2b4
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/stdattrs_8h_source.html
@@ -0,0 +1,180 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/structonlp__asset__info__s.html b/packages/base/any/onlp/src/onlp/doc/html/structonlp__asset__info__s.html
new file mode 100644
index 00000000..03a5d892
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/structonlp__asset__info__s.html
@@ -0,0 +1,279 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
This structure describes general asset information that may be associated with a particular OID. + More...
+ +#include <stdattrs.h>
+Data Fields | |
| onlp_oid_t | oid |
| char * | manufacturer |
| char * | date |
| char * | part_number |
| char * | serial_number |
| char * | hardware_revision |
| char * | firmware_revision |
| char * | cpld_revision |
| char * | manufacture_date |
| char * | description |
| char * | additional |
This structure describes general asset information that may be associated with a particular OID.
+| char* onlp_asset_info_s::additional | +
Additional Information
+ +| char* onlp_asset_info_s::cpld_revision | +
CPLD Revision
+ +| char* onlp_asset_info_s::date | +
Date
+ +| char* onlp_asset_info_s::description | +
Description
+ +| char* onlp_asset_info_s::firmware_revision | +
Firmware Revision
+ +| char* onlp_asset_info_s::hardware_revision | +
Hardware Revision
+ +| char* onlp_asset_info_s::manufacture_date | +
Manufacture Date
+ +| char* onlp_asset_info_s::manufacturer | +
Manufacturer
+ +| onlp_oid_t onlp_asset_info_s::oid | +
The OID to which this asset info belongs
+ +| char* onlp_asset_info_s::part_number | +
Part Number
+ +| char* onlp_asset_info_s::serial_number | +
Serial Number
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/structonlp__chassis__info__s.html b/packages/base/any/onlp/src/onlp/doc/html/structonlp__chassis__info__s.html
new file mode 100644
index 00000000..810c9497
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/structonlp__chassis__info__s.html
@@ -0,0 +1,129 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Chassis Information Structure. + More...
+ +#include <chassis.h>
+Data Fields | |
| onlp_oid_hdr_t | hdr |
Chassis Information Structure.
+| onlp_oid_hdr_t onlp_chassis_info_s::hdr | +
OID Header
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/structonlp__config__settings__s.html b/packages/base/any/onlp/src/onlp/doc/html/structonlp__config__settings__s.html
new file mode 100644
index 00000000..ae6e3a98
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/structonlp__config__settings__s.html
@@ -0,0 +1,141 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
#include <onlp_config.h>
+Data Fields | |
| const char * | name |
| const char * | value |
All compile time options can be queried or displayedConfiguration settings structure.
+| const char* onlp_config_settings_s::name | +
name
+ +| const char* onlp_config_settings_s::value | +
value
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/structonlp__fan__info__s.html b/packages/base/any/onlp/src/onlp/doc/html/structonlp__fan__info__s.html
new file mode 100644
index 00000000..efbc6d12
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/structonlp__fan__info__s.html
@@ -0,0 +1,216 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
#include <fan.h>
+Data Fields | |
| onlp_oid_hdr_t | hdr |
| onlp_fan_dir_t | dir |
| uint32_t | caps |
| int | rpm |
| int | percentage |
| char | model [ONLP_CONFIG_INFO_STR_MAX] |
| char | serial [ONLP_CONFIG_INFO_STR_MAX] |
Fan information structure.
+| uint32_t onlp_fan_info_s::caps | +
Capabilities
+ +| onlp_fan_dir_t onlp_fan_info_s::dir | +
Current direction
+ +| onlp_oid_hdr_t onlp_fan_info_s::hdr | +
OID Header
+ +| char onlp_fan_info_s::model[ONLP_CONFIG_INFO_STR_MAX] | +
Model (if applicable)
+ +| int onlp_fan_info_s::percentage | +
Current fan percentage, if available
+ +| int onlp_fan_info_s::rpm | +
Current fan speed, in RPM, if available
+ +| char onlp_fan_info_s::serial[ONLP_CONFIG_INFO_STR_MAX] | +
Serial Number (if applicable)
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/structonlp__generic__info__s.html b/packages/base/any/onlp/src/onlp/doc/html/structonlp__generic__info__s.html
new file mode 100644
index 00000000..cd397cec
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/structonlp__generic__info__s.html
@@ -0,0 +1,129 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Generic OID Information Structure. + More...
+ +#include <generic.h>
+Data Fields | |
| onlp_oid_hdr_t | hdr |
Generic OID Information Structure.
+| onlp_oid_hdr_t onlp_generic_info_s::hdr | +
OID Header
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/structonlp__led__info__s.html b/packages/base/any/onlp/src/onlp/doc/html/structonlp__led__info__s.html
new file mode 100644
index 00000000..ee868f92
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/structonlp__led__info__s.html
@@ -0,0 +1,171 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
#include <led.h>
+Data Fields | |
| onlp_oid_hdr_t | hdr |
| uint32_t | caps |
| onlp_led_mode_t | mode |
| char | character |
LED information structure.
+| uint32_t onlp_led_info_s::caps | +
Capabilities
+ +| char onlp_led_info_s::character | +
Current char, if capable.
+ +| onlp_oid_hdr_t onlp_led_info_s::hdr | +
Header
+ +| onlp_led_mode_t onlp_led_info_s::mode | +
Current mode, if capable.
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/structonlp__module__info__s.html b/packages/base/any/onlp/src/onlp/doc/html/structonlp__module__info__s.html
new file mode 100644
index 00000000..2f6ba121
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/structonlp__module__info__s.html
@@ -0,0 +1,129 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Module OID Information Structure. + More...
+ +#include <module.h>
+Data Fields | |
| onlp_oid_hdr_t | hdr |
Module OID Information Structure.
+| onlp_oid_hdr_t onlp_module_info_s::hdr | +
OID Header
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/structonlp__oid__hdr__s.html b/packages/base/any/onlp/src/onlp/doc/html/structonlp__oid__hdr__s.html
new file mode 100644
index 00000000..400a99cf
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/structonlp__oid__hdr__s.html
@@ -0,0 +1,186 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
#include <oids.h>
+Data Fields | |
| onlp_oid_t | id |
| onlp_oid_desc_t | description |
| onlp_oid_t | poid |
| onlp_oid_table_t | coids |
| onlp_oid_status_flags_t | status |
All OID objects contain this header as the first member.
+| onlp_oid_table_t onlp_oid_hdr_s::coids | +
The children of this OID
+ +| onlp_oid_desc_t onlp_oid_hdr_s::description | +
The description of this object.
+ +| onlp_oid_t onlp_oid_hdr_s::id | +
The OID
+ +| onlp_oid_t onlp_oid_hdr_s::poid | +
The parent OID of this object.
+ +| onlp_oid_status_flags_t onlp_oid_hdr_s::status | +
The current status (if applicable)
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/structonlp__psu__info__t.html b/packages/base/any/onlp/src/onlp/doc/html/structonlp__psu__info__t.html
new file mode 100644
index 00000000..fca28984
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/structonlp__psu__info__t.html
@@ -0,0 +1,276 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
#include <psu.h>
+Data Fields | |
| onlp_oid_hdr_t | hdr |
| char | model [ONLP_CONFIG_INFO_STR_MAX] |
| char | serial [ONLP_CONFIG_INFO_STR_MAX] |
| uint32_t | caps |
| onlp_psu_type_t | type |
| int | mvin |
| int | mvout |
| int | miin |
| int | miout |
| int | mpin |
| int | mpout |
PSU Information Structure
+| uint32_t onlp_psu_info_t::caps | +
Capabilities
+ +| onlp_oid_hdr_t onlp_psu_info_t::hdr | +
OID Header
+ +| int onlp_psu_info_t::miin | +
milliamps in
+ +| int onlp_psu_info_t::miout | +
milliamps out
+ +| char onlp_psu_info_t::model[ONLP_CONFIG_INFO_STR_MAX] | +
Model
+ +| int onlp_psu_info_t::mpin | +
milliwatts in
+ +| int onlp_psu_info_t::mpout | +
milliwatts out
+ +| int onlp_psu_info_t::mvin | +
millivolts in
+ +| int onlp_psu_info_t::mvout | +
millivolts out
+ +| char onlp_psu_info_t::serial[ONLP_CONFIG_INFO_STR_MAX] | +
Serial Number
+ +| onlp_psu_type_t onlp_psu_info_t::type | +
Type
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/structonlp__sfp__info__t.html b/packages/base/any/onlp/src/onlp/doc/html/structonlp__sfp__info__t.html
new file mode 100644
index 00000000..880c35ad
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/structonlp__sfp__info__t.html
@@ -0,0 +1,233 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
#include <sfp.h>
+Data Fields | |
| onlp_oid_hdr_t | hdr |
| onlp_sfp_type_t | type |
| uint32_t | controls |
| sff_info_t | sff |
| sff_dom_info_t | dom |
| struct { | |
| uint8_t a0 [ONLP_SFP_BLOCK_DATA_SIZE] | |
| uint8_t a2 [ONLP_SFP_BLOCK_DATA_SIZE] | |
| } | bytes |
SFP Information Structure.
+| uint8_t onlp_sfp_info_t::a0[ONLP_SFP_BLOCK_DATA_SIZE] | +
The last A0 data
+ +| uint8_t onlp_sfp_info_t::a2[ONLP_SFP_BLOCK_DATA_SIZE] | +
The last A2 data (for SFP+ only)
+ +| struct { ... } onlp_sfp_info_t::bytes | +
The raw data upon which the meta info is based.
+ +| uint32_t onlp_sfp_info_t::controls | +
The SFP Control Status
+ +| sff_dom_info_t onlp_sfp_info_t::dom | +
The SFF Diagnostics information.
+ +| onlp_oid_hdr_t onlp_sfp_info_t::hdr | +
OID Header
+ +| sff_info_t onlp_sfp_info_t::sff | +
The SFF Parse of the idprom. The parse is valid if sff.sfp_type != INVALID.
+Note that the vendor, model, and serial will likely be populated correctly event if the rest of the data could not be parsed correctly.
+ +| onlp_sfp_type_t onlp_sfp_info_t::type | +
SFP Connector Type
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/structonlp__thermal__info__s.html b/packages/base/any/onlp/src/onlp/doc/html/structonlp__thermal__info__s.html
new file mode 100644
index 00000000..717be55a
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/structonlp__thermal__info__s.html
@@ -0,0 +1,217 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
#include <thermal.h>
+Data Fields | |
| onlp_oid_hdr_t | hdr |
| uint32_t | caps |
| int | mcelsius |
| struct { | |
| int warning | |
| int error | |
| int shutdown | |
| } | thresholds |
Thermal sensor information structure.
+| uint32_t onlp_thermal_info_s::caps | +
Capabilities
+ +| int onlp_thermal_info_s::error | +
Error temperature threshold in milli-celsius
+ +| onlp_oid_hdr_t onlp_thermal_info_s::hdr | +
OID Header
+ +| int onlp_thermal_info_s::mcelsius | +
Current temperature in milli-celsius
+ +| int onlp_thermal_info_s::shutdown | +
System shutdown temperature threshold in milli-celsius
+ +| struct { ... } onlp_thermal_info_s::thresholds | +
Thermal Thresholds
+ +| int onlp_thermal_info_s::warning | +
Warning temperature threshold in milli-celsius
+ +
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/sync_off.png b/packages/base/any/onlp/src/onlp/doc/html/sync_off.png
new file mode 100644
index 00000000..3b443fc6
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/sync_off.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/sync_on.png b/packages/base/any/onlp/src/onlp/doc/html/sync_on.png
new file mode 100644
index 00000000..e08320fb
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/sync_on.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/tab_a.png b/packages/base/any/onlp/src/onlp/doc/html/tab_a.png
new file mode 100644
index 00000000..3b725c41
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/tab_a.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/tab_b.png b/packages/base/any/onlp/src/onlp/doc/html/tab_b.png
new file mode 100644
index 00000000..e2b4a863
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/tab_b.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/tab_h.png b/packages/base/any/onlp/src/onlp/doc/html/tab_h.png
new file mode 100644
index 00000000..fd5cb705
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/tab_h.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/tab_s.png b/packages/base/any/onlp/src/onlp/doc/html/tab_s.png
new file mode 100644
index 00000000..ab478c95
Binary files /dev/null and b/packages/base/any/onlp/src/onlp/doc/html/tab_s.png differ
diff --git a/packages/base/any/onlp/src/onlp/doc/html/tabs.css b/packages/base/any/onlp/src/onlp/doc/html/tabs.css
new file mode 100644
index 00000000..9cf578f2
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/tabs.css
@@ -0,0 +1,60 @@
+.tabs, .tabs2, .tabs3 {
+ background-image: url('tab_b.png');
+ width: 100%;
+ z-index: 101;
+ font-size: 13px;
+ font-family: 'Lucida Grande',Geneva,Helvetica,Arial,sans-serif;
+}
+
+.tabs2 {
+ font-size: 10px;
+}
+.tabs3 {
+ font-size: 9px;
+}
+
+.tablist {
+ margin: 0;
+ padding: 0;
+ display: table;
+}
+
+.tablist li {
+ float: left;
+ display: table-cell;
+ background-image: url('tab_b.png');
+ line-height: 36px;
+ list-style: none;
+}
+
+.tablist a {
+ display: block;
+ padding: 0 20px;
+ font-weight: bold;
+ background-image:url('tab_s.png');
+ background-repeat:no-repeat;
+ background-position:right;
+ color: #283A5D;
+ text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
+ text-decoration: none;
+ outline: none;
+}
+
+.tabs3 .tablist a {
+ padding: 0 10px;
+}
+
+.tablist a:hover {
+ background-image: url('tab_h.png');
+ background-repeat:repeat-x;
+ color: #fff;
+ text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
+ text-decoration: none;
+}
+
+.tablist li.current a {
+ background-image: url('tab_a.png');
+ background-repeat:repeat-x;
+ color: #fff;
+ text-shadow: 0px 1px 1px rgba(0, 0, 0, 1.0);
+}
diff --git a/packages/base/any/onlp/src/onlp/doc/html/thermal_8h.html b/packages/base/any/onlp/src/onlp/doc/html/thermal_8h.html
new file mode 100644
index 00000000..e0f9f7e3
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/thermal_8h.html
@@ -0,0 +1,217 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Thermal Sensor Management. +More...
+ +Go to the source code of this file.
++Data Structures | |
| struct | onlp_thermal_info_s |
+Macros | |
| #define | ONLP_THERMAL_CAPS_ALL 0xF |
| #define | ONLP_THERMAL_CAPS_GET_ANY_THRESHOLD |
| #define | ONLP_THERMAL_THRESHOLD_INIT_DEFAULTS |
| #define | ONLP_THERMAL_INFO_CAP_IS_SET(_pinfo, _name) ((_pinfo)->caps & ONLP_THERMAL_CAPS_##_name) |
| #define | ONLP_THERMAL_CAPS_VALID(_e) (onlp_thermal_caps_valid((_e))) |
| #define | ONLP_THERMAL_THRESHOLD_VALID(_e) (onlp_thermal_threshold_valid((_e))) |
+Typedefs | |
| typedef enum onlp_thermal_caps_e | onlp_thermal_caps_t |
| typedef enum +onlp_thermal_threshold_e | onlp_thermal_threshold_t |
| typedef struct onlp_thermal_info_s | onlp_thermal_info_t |
+Enumerations | |
| enum | onlp_thermal_caps_e { ONLP_THERMAL_CAPS_GET_TEMPERATURE = (1 << 0), +ONLP_THERMAL_CAPS_GET_WARNING_THRESHOLD = (1 << 1), +ONLP_THERMAL_CAPS_GET_ERROR_THRESHOLD = (1 << 2), +ONLP_THERMAL_CAPS_GET_SHUTDOWN_THRESHOLD = (1 << 3) + } |
| enum | onlp_thermal_threshold_e { ONLP_THERMAL_THRESHOLD_WARNING_DEFAULT = 45000, +ONLP_THERMAL_THRESHOLD_ERROR_DEFAULT = 55000, +ONLP_THERMAL_THRESHOLD_SHUTDOWN_DEFAULT = 60000 + } |
+Functions | |
| +int | onlp_thermal_sw_init (void) |
| Software initialization of the thermal module. | |
| int | onlp_thermal_hw_init (uint32_t flags) |
| Hardware initialization of the thermal module. More... | |
| int | onlp_thermal_sw_denit (void) |
| Deinitialize the thermal software module. More... | |
| int | onlp_thermal_hdr_get (onlp_oid_t oid, onlp_oid_hdr_t *rv) |
| Retrieve the thermal's oid header. More... | |
| int | onlp_thermal_info_get (onlp_oid_t oid, onlp_thermal_info_t *rv) |
| Retrieve information about the given thermal id. More... | |
| int | onlp_thermal_info_to_json (onlp_thermal_info_t *info, cJSON **rv, uint32_t flags) |
| Convert a thermal info structure to json. More... | |
| int | onlp_thermal_info_from_json (cJSON *cj, onlp_thermal_info_t *info) |
| Convert a JSON object to a thermal info structure. More... | |
| int | onlp_thermal_info_to_user_json (onlp_thermal_info_t *info, cJSON **rv, uint32_t flags) |
| Convert a thermal info structure to user json. More... | |
| const char * | onlp_thermal_caps_name (onlp_thermal_caps_t e) |
| int | onlp_thermal_caps_value (const char *str, onlp_thermal_caps_t *e, int substr) |
| const char * | onlp_thermal_caps_desc (onlp_thermal_caps_t e) |
| int | onlp_thermal_caps_valid (onlp_thermal_caps_t e) |
| const char * | onlp_thermal_threshold_name (onlp_thermal_threshold_t e) |
| int | onlp_thermal_threshold_value (const char *str, onlp_thermal_threshold_t *e, int substr) |
| const char * | onlp_thermal_threshold_desc (onlp_thermal_threshold_t e) |
| int | onlp_thermal_threshold_valid (onlp_thermal_threshold_t e) |
+Variables | |
| aim_map_si_t | onlp_thermal_caps_map [] |
| aim_map_si_t | onlp_thermal_caps_desc_map [] |
| aim_map_si_t | onlp_thermal_threshold_map [] |
| aim_map_si_t | onlp_thermal_threshold_desc_map [] |
Thermal Sensor Management.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/thermal_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/thermal_8h_source.html
new file mode 100644
index 00000000..d82561c8
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/thermal_8h_source.html
@@ -0,0 +1,269 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/thermali_8h.html b/packages/base/any/onlp/src/onlp/doc/html/thermali_8h.html
new file mode 100644
index 00000000..0b85e6a6
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/thermali_8h.html
@@ -0,0 +1,140 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
Thermal Sensor Platform Implementation. +More...
+#include <onlp/thermal.h>Go to the source code of this file.
++Macros | |
| #define | ONLP_THERMAL_INFO_ENTRY_INIT(_id, _desc, _parent) |
| #define | ONLP_CHASSIS_THERMAL_INFO_ENTRY_INIT(_id, _desc) ONLP_THERMAL_INFO_ENTRY_INIT(_id, _desc, ONLP_OID_CHASSIS) |
| #define | ONLP_PSU_THERMAL_INFO_ENTRY_INIT(_id, _desc, _psu_id) ONLP_THERMAL_INFO_ENTRY_INIT(_id, _desc, ONLP_PSU_ID_CREATE(_psu_id)) |
+Functions | |
| +int | onlp_thermali_sw_init (void) |
| Software initialization of the Thermal module. | |
| int | onlp_thermali_hw_init (uint32_t flags) |
| Hardware initialization of the Thermal module. More... | |
| int | onlp_thermali_sw_denit (void) |
| Deinitialize the thermal software module. More... | |
| int | onlp_thermali_hdr_get (onlp_oid_id_t id, onlp_oid_hdr_t *rv) |
| Retrieve the thermal's oid header. More... | |
| int | onlp_thermali_info_get (onlp_oid_id_t id, onlp_thermal_info_t *rv) |
| Get the information for the given thermal OID. More... | |
Thermal Sensor Platform Implementation.
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/doc/html/thermali_8h_source.html b/packages/base/any/onlp/src/onlp/doc/html/thermali_8h_source.html
new file mode 100644
index 00000000..a1c4f4c7
--- /dev/null
+++ b/packages/base/any/onlp/src/onlp/doc/html/thermali_8h_source.html
@@ -0,0 +1,162 @@
+
+
+
+
+
+
+|
+ ONLP
+
+ Open Network Linux Platform APIs
+ |
+
+ 1.8.8
+
+
+
diff --git a/packages/base/any/onlp/src/onlp/module/auto/onlp.yml b/packages/base/any/onlp/src/onlp/module/auto/onlp.yml
index 0fc16437..3fa69e27 100644
--- a/packages/base/any/onlp/src/onlp/module/auto/onlp.yml
+++ b/packages/base/any/onlp/src/onlp/module/auto/onlp.yml
@@ -119,33 +119,11 @@ oid_status: &oid_status
- OPERATIONAL
- UNPLUGGED
-# OID Output Format
-oid_format_types: &oid_format_types
-- JSON
-- YAML
-- USER
-- DEBUG
-
-# OID Output Flags
-oid_format_flags: &oid_format_flags
-- RECURSIVE
-- MISSING
-
-# OID dump options
-oid_dump: &oid_dump
-- RECURSE
-- EVEN_IF_ABSENT
-
-# OID show options
-oid_show: &oid_show
-- RECURSE
-- EXTENDED
-- YAML
-
# OID JSON Flags
oid_json_flags: &oid_json_flags
- RECURSIVE
- UNSUPPORTED_FIELDS
+- TO_USER_JSON
# SFP Control
sfp_control: &sfp_controls
@@ -269,24 +247,6 @@ definitions:
members: *oid_status
flags: True
- onlp_oid_format:
- tag: oid
- members: *oid_format_types
-
- onlp_oid_format_flags:
- tag: oid
- members: *oid_format_flags
- flags: True
-
- onlp_oid_show:
- tag: oid
- members: *oid_show
- flags: True
-
- onlp_oid_dump:
- tag: oid
- members: *oid_dump
-
onlp_oid_json_flag:
tag: oid
members: *oid_json_flags
@@ -364,7 +324,7 @@ definitions:
ONLP_ASSET_INFO_ENTRY:
members:
- - manufacturer, Manufacture, str
+ - manufacturer, Manufacturer, str
- date, Date, str
- part_number, Part Number, str
- serial_number, Serial Number, str
diff --git a/packages/base/any/onlp/src/onlp/module/inc/onlp/attribute.h b/packages/base/any/onlp/src/onlp/module/inc/onlp/attribute.h
index 29739e43..5411f0cb 100644
--- a/packages/base/any/onlp/src/onlp/module/inc/onlp/attribute.h
+++ b/packages/base/any/onlp/src/onlp/module/inc/onlp/attribute.h
@@ -36,8 +36,17 @@
/**
* @brief Initialize the attribute subsystem.
+ * @note This function can only perform software module initialization.
+ * It cannot affect the state of the hardware.
*/
int onlp_attribute_sw_init(void);
+
+/**
+ * @brief Hardware initialization of the attribute subsystem.
+ * @param flags The initialization flags.
+ * @note This function will be called once at system startup
+ * by the ONLP core. You should not call it.
+ */
int onlp_attribute_hw_init(uint32_t flags);
/**
@@ -79,14 +88,16 @@ int onlp_attribute_free(onlp_oid_t oid, const char* attribute, void* value);
/******************************************************************************
*
- * These functions facilitate access to standard attributes.
+ * These functions provide access to standard ONIE and Asset attributes.
+ * These are so common that they have their own interface for
+ * for both the user and the platform implementations.
*
*****************************************************************************/
-
/**
* @brief Request the ONIE attribute.
* @param oid The target OID.
* @param [out] rp Receives the ONIE information structure pointer.
+ * @note Setting rp to NULL will determine if the ONIE attribute is supported.
*/
int onlp_attribute_onie_info_get(onlp_oid_t oid, onlp_onie_info_t** rp);
@@ -109,13 +120,27 @@ int onlp_attribute_onie_info_get_json(onlp_oid_t oid, cJSON** rp);
* @brief Show the ONIE attribute.
* @param oid The target OID.
* @param pvs The output pvs.
+ * @note The output is YAML in human-readble format.
*/
int onlp_attribute_onie_info_show(onlp_oid_t oid, aim_pvs_t* pvs);
+/**
+ * @brief Show the ONIE attribute (JSON)
+ * @param oid The target OID.
+ * @param pvs The output pvs.
+ */
+int onlp_attribute_onie_info_show_json(onlp_oid_t oid, aim_pvs_t* pvs);
+
+/**
+ * @brief Determine if the ONIE attribute is supported.
+ * @param oid The target OID.
+ * @note Retu
+ */
/**
* @brief Request the asset attribute.
* @param oid The target oid.
* @param [out] rp Receives the Asset information structure pointer.
+ * @note Setting rp to NULL will determine if the attribute is supported.
*/
int onlp_attribute_asset_info_get(onlp_oid_t oid, onlp_asset_info_t** rp);
@@ -138,8 +163,16 @@ int onlp_attribute_asset_info_get_json(onlp_oid_t oid, cJSON** rp);
* @brief Show the asset attribute.
* @param oid The target oid.
* @param pvs The output pvs.
+ * @note The output format is YAML in human-readable format.
*/
int onlp_attribute_asset_info_show(onlp_oid_t oid, aim_pvs_t* pvs);
+/**
+ * @brief Show the asset attribute (JSON).
+ * @param oid The target oid.
+ * @param pvs The output pvs.
+ */
+int onlp_attribute_asset_info_show_json(onlp_oid_t oid, aim_pvs_t* pvs);
+
#endif /* __ONLP_ATTRIBUTE_H__ */
/* @} */
diff --git a/packages/base/any/onlp/src/onlp/module/inc/onlp/chassis.h b/packages/base/any/onlp/src/onlp/module/inc/onlp/chassis.h
index 7b5e4a81..44272f7e 100644
--- a/packages/base/any/onlp/src/onlp/module/inc/onlp/chassis.h
+++ b/packages/base/any/onlp/src/onlp/module/inc/onlp/chassis.h
@@ -88,32 +88,67 @@ int onlp_chassis_hdr_get(onlp_oid_t oid, onlp_oid_hdr_t* hdr);
int onlp_chassis_info_get(onlp_oid_t oid, onlp_chassis_info_t* info);
/**
- * @brief Format a chassis oid.
- * @param oid The chassis oid.
- * @param format The output format.
- * @param pvs The output pvs.
- * @param flags The output flags.
+ * @brief Convert a chassis info structure to user JSON.
+ * @param info The chassis info structure.
+ * @param [out] cj Receives the JSON object.
+ * @param flags The JSON format flags.
*/
-int onlp_chassis_format(onlp_oid_t oid, onlp_oid_format_t format,
- aim_pvs_t* pvs, uint32_t flags);
+int onlp_chassis_info_to_user_json(onlp_chassis_info_t* info, cJSON** cj, uint32_t flags);
+
+/**
+ * @brief Convert a chassis info structure to JSON.
+ * @param info The chassis info structure.
+ * @param [out] cj Receives the JSON object.
+ * @param flags The JSON format flags.
+ */
+int onlp_chassis_info_to_json(onlp_chassis_info_t* info, cJSON** cj, uint32_t flags);
+
+/**
+ * @brief Convert a JSON object to a chassis info structure.
+ * @param cj The JSON object.
+ * @param [out] info Receives the chassis info.
+ */
+int onlp_chassis_info_from_json(cJSON* cj, onlp_chassis_info_t* info);
+
+/******************************************************************************
+ *
+ * Standard Chassis Features
+ *
+ *****************************************************************************/
+
+/**
+ * @brief Get the user or full environmental json data.
+ * @param [out] cjp Receives the JSON data.
+ * @param flags Zero or ONLP_OID_JSON_FLAG_TO_USER_JSON only.
+ * @note This will provide the user view of the environmental data
+
+ * with keys in the following order:
+ * Chassis Fans
+ * Chassis Thermals
+ * Chassis PSUs
+ */
+int onlp_chassis_environment_to_json(cJSON** cjp, uint32_t flags);
/**
- * @brief Format a chassis info structure.
- * @param info The chassis info structure.
- * @param format The output format.
+ * @brief Show the environmental data.
* @param pvs The output pvs.
- * @param flags The output flags.
+ * @param flags Zero or ONLP_OID_JSON_FLAG_TO_USER_JSON only.
+ * @note See onlp_chassis_environment_to_json()
*/
-int onlp_chassis_info_format(onlp_chassis_info_t* info, onlp_oid_format_t format,
- aim_pvs_t* pvs, uint32_t flags);
+int onlp_chassis_environment_show(aim_pvs_t* pvs, uint32_t flags);
-int onlp_chassis_info_to_user_json(onlp_chassis_info_t* info, cJSON** rv, uint32_t flags);
-int onlp_chassis_info_to_json(onlp_chassis_info_t* info, cJSON** rv, uint32_t flags);
-int onlp_chassis_info_from_json(cJSON* cj, onlp_chassis_info_t* info);
+/**
+ * @brief Construct the Chassis debug JSON object.
+ * @param [out] rv Receives the JSON object.
+ */
+int onlp_chassis_debug_get_json(cJSON** rv);
-
-int onlp_chassis_environment(aim_pvs_t* pvs);
+/**
+ * @brief Show the Chassis debug information.
+`* @param pvs The output pvs.
+ */
+int onlp_chassis_debug_show(aim_pvs_t* pvs);
#endif /* __ONLP_CHASSIS_H_ */
/* @} */
diff --git a/packages/base/any/onlp/src/onlp/module/inc/onlp/fan.h b/packages/base/any/onlp/src/onlp/module/inc/onlp/fan.h
index f6d5c3ea..2fa8f5cc 100644
--- a/packages/base/any/onlp/src/onlp/module/inc/onlp/fan.h
+++ b/packages/base/any/onlp/src/onlp/module/inc/onlp/fan.h
@@ -82,6 +82,9 @@ typedef struct onlp_fan_info_s {
} onlp_fan_info_t;
+/**
+ * @brief Determine if a fan capability is set.
+ */
#define ONLP_FAN_INFO_CAP_IS_SET(_pinfo, _name) \
((_pinfo)->caps & ONLP_FAN_CAPS_##_name)
@@ -118,27 +121,6 @@ int onlp_fan_hdr_get(onlp_oid_t id, onlp_oid_hdr_t* hdr);
*/
int onlp_fan_info_get(onlp_oid_t id, onlp_fan_info_t* rv);
-
-/**
- * @brief Format a fan oid.
- * @param oid The fan oid.
- * @param format The output format.
- * @param pvs The output pvs.
- * @param flags The output flags.
- */
-int onlp_fan_format(onlp_oid_t oid, onlp_oid_format_t format,
- aim_pvs_t* pvs, uint32_t flags);
-
-/**
- * @brief Format a fan information structure.
- * @param info The fan information structure.
- * @param format The output format.
- * @param pvs The output pvs.
- * @param flags The output flags.
- */
-int onlp_fan_info_format(onlp_fan_info_t* info, onlp_oid_format_t format,
- aim_pvs_t* pvs, uint32_t flags);
-
/**
* @brief Set the fan speed in RPMs.
* @param id The fan OID.
@@ -163,6 +145,31 @@ int onlp_fan_percentage_set(onlp_oid_t id, int p);
*/
int onlp_fan_dir_set(onlp_oid_t id, onlp_fan_dir_t dir);
+/**
+ * @brief Convert a fan info structure to user JSON.
+ * @param info The fan info structure.
+ * @param [out] cj Receives the JSON object.
+ * @param flags The JSON format flags.
+ */
+int onlp_fan_info_to_user_json(onlp_fan_info_t* info, cJSON** cj,
+ uint32_t flags);
+
+/**
+ * @brief Convert a fan info structure to JSON.
+ * @param info The fan info structure.
+ * @param [out] cj Receives the JSON object.
+ * @param flags The JSON format flags.
+ */
+int onlp_fan_info_to_json(onlp_fan_info_t* info, cJSON** cj, uint32_t flags);
+
+/**
+ * @brief Convert a JSON object to a fan info structure.
+ * @param cj The JSON object.
+ * @param [out] info Recieves the fan info structure.
+ */
+int onlp_fan_info_from_json(cJSON* cj, onlp_fan_info_t* info);
+
+
/** Fan is present. */
#define ONLP_FAN_STATUS_PRESENT(_fi) ((_fi).hdr.status & ONLP_OID_STATUS.PRESENT)
@@ -176,15 +183,6 @@ int onlp_fan_dir_set(onlp_oid_t id, onlp_fan_dir_t dir);
#define ONLP_FAN_STATUS_NORMAL(_fi) ( ONLP_FAN_STATUS_PRESENT(_fi) && !ONLP_FAN_STATUS_FAILED(_fi) )
-
-
-int onlp_fan_info_to_user_json(onlp_fan_info_t* info, cJSON** cj,
- uint32_t flags);
-
-int onlp_fan_info_to_json(onlp_fan_info_t* info, cJSON** cj, uint32_t flags);
-int onlp_fan_info_from_json(cJSON* cj, onlp_fan_info_t* info);
-
-
/******************************************************************************
*
* Enumeration Support Definitions.
diff --git a/packages/base/any/onlp/src/onlp/module/inc/onlp/generic.h b/packages/base/any/onlp/src/onlp/module/inc/onlp/generic.h
index be4a8c82..a92d1d3a 100644
--- a/packages/base/any/onlp/src/onlp/module/inc/onlp/generic.h
+++ b/packages/base/any/onlp/src/onlp/module/inc/onlp/generic.h
@@ -82,28 +82,26 @@ int onlp_generic_hdr_get(onlp_oid_t oid, onlp_oid_hdr_t* hdr);
int onlp_generic_info_get(onlp_oid_t oid, onlp_generic_info_t* info);
/**
- * @brief Format a Generic OID.
- * @param oid The generic oid.
- * @param format The output format.
- * @param pvs The output pvs.
- * @param flags The output flags.
+ * @brief Convert a generic info structure to user JSON.
+ * @param info The generic info structure.
+ * @param [out] cj Receives the JSON object.
+ * @param flags The JSON format flags.
*/
-int onlp_generic_format(onlp_oid_t oid, onlp_oid_format_t format,
- aim_pvs_t* pvs, uint32_t flags);
+int onlp_generic_info_to_user_json(onlp_generic_info_t* info, cJSON** cj, uint32_t flags);
/**
- * @brief Format a generic information structure.
+ * @brief Convert a generic info structure to JSON.
* @param info The generic info structure.
- * @param format The output format.
- * @param pvs The output pvs.
- * @param flags The output flags.
+ * @param [out] cj Receives the JSON object.
+ * @param flags The JSON format flags.
*/
-int onlp_generic_info_format(onlp_generic_info_t* info,
- onlp_oid_format_t format,
- aim_pvs_t* pvs, uint32_t flags);
+int onlp_generic_info_to_json(onlp_generic_info_t* info, cJSON** cj, uint32_t flags);
-int onlp_generic_info_to_user_json(onlp_generic_info_t* info, cJSON** rv, uint32_t flags);
-int onlp_generic_info_to_json(onlp_generic_info_t* info, cJSON** rv, uint32_t flags);
+/**
+ * @brief Convert a JSON object to a generic info structure.
+ * @param cj The JSON object.
+ * @param [out] info Receives the generic info structure.
+ */
int onlp_generic_info_from_json(cJSON* cj, onlp_generic_info_t* info);
#endif /* __ONLP_GENERIC_H_ */
diff --git a/packages/base/any/onlp/src/onlp/module/inc/onlp/led.h b/packages/base/any/onlp/src/onlp/module/inc/onlp/led.h
index ca587f78..176dbb65 100644
--- a/packages/base/any/onlp/src/onlp/module/inc/onlp/led.h
+++ b/packages/base/any/onlp/src/onlp/module/inc/onlp/led.h
@@ -125,28 +125,6 @@ int onlp_led_hdr_get(onlp_oid_t id, onlp_oid_hdr_t* rv);
*/
int onlp_led_info_get(onlp_oid_t id, onlp_led_info_t* rv);
-
-/**
- * @brief Format an LED OID.
- * @param oid The OID.
- * @param format The output format.
- * @param pvs The output pvs.
- * @param flags The output flags.
- */
-int onlp_led_format(onlp_oid_t oid, onlp_oid_format_t format,
- aim_pvs_t* pvs, uint32_t flags);
-
-/**
- * @brief Format an LED information structure.
- * @param info The information structure.
- * @param format The output format.
- * @param pvs The output pvs.
- * @param flags The output flags.
- */
-int onlp_led_info_format(onlp_led_info_t* info, onlp_oid_format_t format,
- aim_pvs_t* pvs, uint32_t flags);
-
-
/**
* @brief Set the LED color
* @param id The LED OID
@@ -164,8 +142,27 @@ int onlp_led_mode_set(onlp_oid_t id, onlp_led_mode_t mode);
*/
int onlp_led_char_set(onlp_oid_t id, char c);
-int onlp_led_info_to_user_json(onlp_led_info_t* info, cJSON** rv, uint32_t flags);
-int onlp_led_info_to_json(onlp_led_info_t* info, cJSON** rv, uint32_t flags);
+/**
+ * @brief Convert an LED info structure to user JSON.
+ * @param info The LED info structure.
+ * @param [out] cj Receives the JSON object.
+ * @param flags The JSON format flags.
+ */
+int onlp_led_info_to_user_json(onlp_led_info_t* info, cJSON** cj, uint32_t flags);
+
+/**
+ * @brief Convert an LED info structure to JSON.
+ * @param info The LED info structure.
+ * @param [out] cj Receives the JSON object.
+ * @param flags The JSON format flags.
+ */
+int onlp_led_info_to_json(onlp_led_info_t* info, cJSON** cj, uint32_t flags);
+
+/**
+ * @brief Convert a JSON object to an LED info structure.
+ * @param cj The JSON oibject.
+ * @param [out] info Receives the LED info structure.
+ */
int onlp_led_info_from_json(cJSON* cj, onlp_led_info_t* info);
/******************************************************************************
diff --git a/packages/base/any/onlp/src/onlp/module/inc/onlp/module.h b/packages/base/any/onlp/src/onlp/module/inc/onlp/module.h
index b08caa84..54e21b10 100644
--- a/packages/base/any/onlp/src/onlp/module/inc/onlp/module.h
+++ b/packages/base/any/onlp/src/onlp/module/inc/onlp/module.h
@@ -67,7 +67,7 @@ int onlp_module_hw_init(uint32_t flags);
*/
int onlp_module_sw_denit(void);
-/*
+/**
* @brief Get the module header structure.
* @param oid The Module oid.
* @param[out] hdr Receives the header.
@@ -81,14 +81,27 @@ int onlp_module_hdr_get(onlp_oid_t oid, onlp_oid_hdr_t* hdr);
*/
int onlp_module_info_get(onlp_oid_t oid, onlp_module_info_t* info);
-int onlp_module_format(onlp_oid_t oid, onlp_oid_format_t format,
- aim_pvs_t* pvs, uint32_t flags);
-
-int onlp_module_info_format(onlp_module_info_t* info, onlp_oid_format_t format,
- aim_pvs_t* pvs, uint32_t flags);
-
+/**
+ * @brief Convert a module info structure to user JSON.
+ * @param info The module info structure.
+ * @param [out] rv Receives the JSON object.
+ * @param flags The JSON format flags.
+ */
int onlp_module_info_to_user_json(onlp_module_info_t* info, cJSON** rv, uint32_t flags);
+
+/**
+ * @brief Convert a module info structure to JSON.
+ * @param info The module info structure.
+ * @param [out] rv Receives the JSON object.
+ * @param flags The JSON format flags.
+ */
int onlp_module_info_to_json(onlp_module_info_t* info, cJSON** rv, uint32_t flags);
+
+/**
+ * @brief Convert a JSON object to a module info structure.
+ * @param cj The JSON object.
+ * @param [out] info Receives the module info structure.
+ */
int onlp_module_info_from_json(cJSON* cj, onlp_module_info_t* info);
#endif /* __ONLP_MODULE_H_ */
diff --git a/packages/base/any/onlp/src/onlp/module/inc/onlp/oids.h b/packages/base/any/onlp/src/onlp/module/inc/onlp/oids.h
index 85b7351b..a57bb478 100644
--- a/packages/base/any/onlp/src/onlp/module/inc/onlp/oids.h
+++ b/packages/base/any/onlp/src/onlp/module/inc/onlp/oids.h
@@ -47,47 +47,16 @@
*/
typedef uint32_t onlp_oid_t;
+typedef uint32_t onlp_oid_id_t;
/*