README: Rework OEM notes
I feel the expectations are more easily expressed as a list, in which
case we don't require the diagram any longer. The diagram hadn't been
updated since we chopped libpldm out of openbmc/pldm.git, and had
some minor oddities. It's not necessary to rework it if we just drop
it entirely.
Change-Id: Iea329604fee9438c1f35a8873e0b2923edb1abda
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>
diff --git a/README.md b/README.md
index 9b18c86..4066b48 100644
--- a/README.md
+++ b/README.md
@@ -182,36 +182,22 @@
## OEM/vendor-specific functions
-This will support OEM or vendor-specific functions and semantic information.
-Following directory structure has to be used:
+libpldm accepts support for OEM or vendor-specific extensions. To add support
+for an OEM's extensions:
-```text
- libpldm
- |---- include/libpldm
- | |---- oem/<oem_name>
- | |----<oem based .h files>
- |---- src
- | |---- oem/<oem_name>
- | |----<oem based .c files>
- |---- tests
- | |---- oem/<oem_name>
- | |----<oem based test files>
+1. Document the wire format for all OEM messages under `docs/oem/${OEM_NAME}/`
-```
+2. Add public OEM API declarations and definitions under
+ `include/libpldm/oem/${OEM_NAME}/`, and install them to the same relative
+ location.
-<oem_name> - This folder must be created with the name of the OEM/vendor in
+3. Implement the public OEM APIs under `src/oem/${OEM_NAME}/`
+
+4. Implement the OEM API tests under `tests/oem/${OEM_NAME}/`
+
+The `${OEM_NAME}` folder must be created with the name of the OEM/vendor in
lower case.
-Header files & source files having the oem functionality for the libpldm library
-should be placed under the respective folder hierarchy as mentioned in the above
-figure. They must be adhering to the rules mentioned under the libpldm section
-above.
-
-Once the above is done a meson option has to be created in `meson.options` with
-its mapped compiler flag to enable conditional compilation.
-
-For consistency would recommend using "oem-<oem_name>".
-
Finally, the OEM name must be added to the list of choices for the `oem` meson
option, and the `meson.build` files updated throughout the tree to guard
integration of the OEM extensions.