Skip to content

Commit

Permalink
doc: prettify FSP Code update docs
Browse files Browse the repository at this point in the history
Signed-off-by: Stewart Smith <stewart@linux.ibm.com>
  • Loading branch information
stewartsmith committed Jun 3, 2019
1 parent c22375d commit 4653773
Showing 1 changed file with 31 additions and 2 deletions.
33 changes: 31 additions & 2 deletions doc/opal-api/opal-code-update-76-77-78.rst
@@ -1,15 +1,27 @@
Code Update on FSP based machine
================================

There are three OPAL calls for code update on FSP based machine: ::
There are three OPAL calls for code update. These are currently only
implemented on FSP based machines.

.. code-block::c
#define OPAL_FLASH_VALIDATE 76
#define OPAL_FLASH_MANAGE 77
#define OPAL_FLASH_UPDATE 78
.. _OPAL_FLASH_VALIDATE:

OPAL_FLASH_VALIDATE
-------------------

.. code-block:: c
#define OPAL_FLASH_VALIDATE 76
int64_t fsp_opal_validate_flash(uint64_t buffer, uint32_t *size, uint32_t *result);
Validate new image is valid for this platform or not. We do below
validation in OPAL:

Expand Down Expand Up @@ -48,9 +60,17 @@ Return value
^^^^^^^^^^^^
Validation status

.. _OPAL_FLASH_MANAGE:

OPAL_FLASH_MANAGE
-----------------

.. code-block:: c
#define OPAL_FLASH_MANAGE 77
int64_t fsp_opal_manage_flash(uint8_t op);
Commit/Reject image.

- We can commit new image (T -> P), if system is running with T side image.
Expand All @@ -69,8 +89,17 @@ op
Return value
Commit operation status (0 : Success)

.. _OPAL_FLASH_UPDATE:

OPAL_FLASH_UPDATE
------------------
-----------------

.. code-block:: c
#define OPAL_FLASH_UPDATE 78
int64_t fsp_opal_update_flash(struct opal_sg_list *list);
Update new image. It only sets the flag, actual update happens
during system reboot/shutdown.

Expand Down

0 comments on commit 4653773

Please sign in to comment.