SST: Use asset ID instead of handle in all APIs
This patch updates the SST interfaces to:
- use asset ID instead of asset handle as the object is always
close at the end of each request
- change the asset ID type from uint16_t to uint32_t to allow
longer asset IDs which can contain vendor specific ID codes
- remove tfm_sst_get_handle API
- updates all files which depend on these APIs and
their documentation
Change-Id: I4a844e548cc7cdfe2277b007717003a0263e45d1
Signed-off-by: Marc Moreno <marc.morenoberengue@arm.com>
diff --git a/interface/include/tfm_sst_api.h b/interface/include/tfm_sst_api.h
index 1ce8261..8447bd4 100644
--- a/interface/include/tfm_sst_api.h
+++ b/interface/include/tfm_sst_api.h
@@ -15,21 +15,7 @@
#include "tfm_sst_defs.h"
/**
- * \brief Gets handler for the given asset UUID. If an asset is deleted, the
- * linked asset handle reference is no longer valid and will give
- * TFM_SST_ERR_ASSET_REF_INVALID if used.
- *
- * \param[in] asset_uuid Asset UUID
- * \param[out] hdl Pointer to store the asset's handler
- *
- * \return Returns TFM_SST_ERR_SUCCESS if asset is found. Otherwise, error code
- * as specified in \ref tfm_sst_err_t
- */
-enum tfm_sst_err_t tfm_sst_get_handle(uint16_t asset_uuid,
- uint32_t* hdl);
-
-/**
- * \brief Allocates space for the asset, referenced by asset handler,
+ * \brief Allocates space for the asset, referenced by asset UUID,
* without setting any data in the asset.
*
* \param[in] asset_uuid Asset UUID
@@ -37,77 +23,77 @@
* \return Returns an TFM_SST_ERR_SUCCESS if asset is created correctly.
* Otherwise, error code as specified in \ref tfm_sst_err_t
*/
-enum tfm_sst_err_t tfm_sst_create(uint16_t asset_uuid);
+enum tfm_sst_err_t tfm_sst_create(uint32_t asset_uuid);
/**
- * \brief Gets asset's information referenced by asset handler.
+ * \brief Gets asset's information referenced by asset UUID.
*
- * \param[in] asset_handle Asset handler
- * \param[out] info Pointer to store the asset's information
- * \ref tfm_sst_asset_info_t
+ * \param[in] asset_uuid Asset UUID
+ * \param[out] info Pointer to store the asset's information
+ * \ref tfm_sst_asset_info_t
*
* \return Returns error code as specified in \ref tfm_sst_err_t
*/
-enum tfm_sst_err_t tfm_sst_get_info(uint32_t asset_handle,
+enum tfm_sst_err_t tfm_sst_get_info(uint32_t asset_uuid,
struct tfm_sst_asset_info_t *info);
/**
- * \brief Gets asset's attributes referenced by asset handler.
+ * \brief Gets asset's attributes referenced by asset UUID.
*
- * \param[in] asset_handle Asset handler
- * \param[out] attrs Pointer to store the asset's attributes
- * \ref tfm_sst_asset_attrs_t
- *
+ * \param[in] asset_uuid Asset UUID
+ * \param[out] attrs Pointer to store the asset's attributes
+ * \ref tfm_sst_asset_attrs_t
*
* \return Returns error code as specified in \ref tfm_sst_err_t
*/
-enum tfm_sst_err_t tfm_sst_get_attributes(uint32_t asset_handle,
+enum tfm_sst_err_t tfm_sst_get_attributes(uint32_t asset_uuid,
struct tfm_sst_asset_attrs_t *attrs);
/**
- * \brief Sets asset's attributes referenced by asset handler.
+ * \brief Sets asset's attributes referenced by asset UUID.
*
- * \param[in] asset_handle Asset handler
- * \param[in] attrs Pointer to new the asset's attributes
- * \ref tfm_sst_asset_attrs_t
+ * \param[in] asset_uuid Asset UUID
+ * \param[in] attrs Pointer to new the asset's attributes
+ * \ref tfm_sst_asset_attrs_t
*
* \return Returns error code as specified in \ref tfm_sst_err_t
*/
-enum tfm_sst_err_t tfm_sst_set_attributes(uint32_t asset_handle,
+enum tfm_sst_err_t tfm_sst_set_attributes(
+ uint32_t asset_uuid,
const struct tfm_sst_asset_attrs_t *attrs);
/**
- * \brief Reads asset's data from asset referenced by asset handler.
+ * \brief Reads asset's data from asset referenced by asset UUID.
*
- * \param[in] asset_handle Asset handler
- * \param[out] data Pointer to data vector \ref tfm_sst_buf_t to store
- * data, size and offset
+ * \param[in] asset_uuid Asset UUID
+ * \param[out] data Pointer to data vector \ref tfm_sst_buf_t to store
+ * data, size and offset
*
* \return Returns error code as specified in \ref tfm_sst_err_t
*/
-enum tfm_sst_err_t tfm_sst_read(uint32_t asset_handle,
+enum tfm_sst_err_t tfm_sst_read(uint32_t asset_uuid,
struct tfm_sst_buf_t* data);
/**
- * \brief Writes data into an asset referenced by asset handler.
+ * \brief Writes data into an asset referenced by asset UUID.
*
- * \param[in] asset_handle Asset handler
- * \param[in] data Pointer to data vector \ref tfm_sst_buf_t which
- * contains the data to write
+ * \param[in] asset_uuid Asset UUID
+ * \param[in] data Pointer to data vector \ref tfm_sst_buf_t which
+ * contains the data to write
*
* \return Returns error code as specified in \ref tfm_sst_err_t
*/
-enum tfm_sst_err_t tfm_sst_write(uint32_t asset_handle,
+enum tfm_sst_err_t tfm_sst_write(uint32_t asset_uuid,
struct tfm_sst_buf_t* data);
/**
- * \brief Deletes the asset referenced by the asset handler.
+ * \brief Deletes the asset referenced by the asset UUID.
*
- * \param[in] asset_handle Asset handler
+ * \param[in] asset_uuid Asset UUID
*
* \return Returns error code as specified in \ref tfm_sst_err_t
*/
-enum tfm_sst_err_t tfm_sst_delete(uint32_t asset_handle);
+enum tfm_sst_err_t tfm_sst_delete(uint32_t asset_uuid);
#ifdef __cplusplus
}