From 5f999ce485931a55d5b66fb406275c6e50151434 Mon Sep 17 00:00:00 2001 From: Jeffrey Townsend Date: Tue, 8 Jan 2019 16:51:40 -0800 Subject: [PATCH] update --- onlp/implementors/apis.md | 2 +- onlp/implementors/getting_started.md | 12 ++++++------ onlp/implementors/psui.md | 2 +- onlp/implementors/sfpi.md | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/onlp/implementors/apis.md b/onlp/implementors/apis.md index 89d2597e..00e199ff 100644 --- a/onlp/implementors/apis.md +++ b/onlp/implementors/apis.md @@ -10,7 +10,7 @@ * [ledi](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/implementors/ledi) * [modulei](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/implementors/modulei) * [generici](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/implementors/generici) -* [attributei](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/implementors/attributesi) +* [attributei](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/implementors/attributei) ## System APIs * [platformi](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/implementors/platformi) diff --git a/onlp/implementors/getting_started.md b/onlp/implementors/getting_started.md index 6a0fe929..0481602d 100644 --- a/onlp/implementors/getting_started.md +++ b/onlp/implementors/getting_started.md @@ -18,15 +18,15 @@ For those that like to browse the code early all available interfaces are define ## Initialization -### Platform Discovery and Assignement +### Platform Discovery and Assignment When the ONLP layer initializes the first thing it will do is ask your implementation the name of the platform for which it is written. You must implement ```onlp_platformi_get()``` to return the name of your platform implementation. For example, if your ONL platform is ```x86-64-fantastinet-fnt9000-r0``` then this is what your ```onlp_platformi_get()``` should return. -The ONLP layer compares this to the current platform if it matches then initialization proceeds. +The ONLP layer compares this to the current platform and if it matches then initialization proceeds. #### A note about multiple platform support in your implementation -While most implementations will only support a single platform, you may have a scenario in which there are multiple subplatforms supported by your implementation -- usually because there are little or no software visible differences. +While most implementations will only support a single platform, you may have a scenario in which there are multiple platforms variants supported by your implementation -- usually because there are little or no software visible differences. In this case you might return something like ```x86-64-fantastinet-fnt9000-rX``` because you want to support both the r0 and r1 versions of your platform. If the name returned by ```onlp_platformi_get()``` does not match the current platform then we will ask you to configure yourself for the current platform by calling ```onlp_platformi_set("x86-64-fantastinet-fnt9000-r0")```. If this functions returns successfully then we assume you have configured yourself correctly and will continue with initialization. @@ -44,13 +44,13 @@ After platform assignment is complete all of the following SW init functions wil * ```onlp_sfpi_sw_init()``` * ```onlp_generici_sw_init()``` -All of these functions are optional. You only need to implement the vectors which do something useful. The default implementations of these vectors just return successfully. +All of these functions are optional. You only need to implement the vectors which do something useful. You do not need empty stubs - the default implementations of these vectors just return successfully. -If any of your SW init functions fail then initialization fails. This is not an expected condition. +If any of your SW init functions fail then initialization fails. This is not an expected condition and will preclude all other operation. ### API Operations What happens after initialization is up to the application. Once your modules are initialized then their entry points will be called by the ONLP layer in response to application requests. --- -[Next: ONLP Platform Implementation APIs](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/applications/api) +[Next: ONLP Platform Implementation APIs](http://opencomputeproject.github.io/OpenNetworkLinux/onlp/implementors/apis) diff --git a/onlp/implementors/psui.md b/onlp/implementors/psui.md index 8c8b5d3a..9fb87592 100644 --- a/onlp/implementors/psui.md +++ b/onlp/implementors/psui.md @@ -1 +1 @@ -# chassis +# psui diff --git a/onlp/implementors/sfpi.md b/onlp/implementors/sfpi.md index 8c8b5d3a..da14e8f4 100644 --- a/onlp/implementors/sfpi.md +++ b/onlp/implementors/sfpi.md @@ -1 +1 @@ -# chassis +# sfpi