[BugFix] PDK-7390: SA LLD API guide missing from PDK documentation
authorPrasad Konnur <prasadkonnur@ti.com>
Thu, 19 Nov 2020 10:03:14 +0000 (15:33 +0530)
committerPrasad Konnur <prasadkonnur@ti.com>
Thu, 19 Nov 2020 10:03:14 +0000 (15:33 +0530)
Signed-off-by: Prasad Konnur <prasadkonnur@ti.com>
salld.h [changed mode: 0644->0755]

diff --git a/salld.h b/salld.h
old mode 100644 (file)
new mode 100755 (executable)
index ffe9022..f5313fc
--- a/salld.h
+++ b/salld.h
  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  *
 */
-/**  @mainpage Security Accelerator Low Level Driver
+
+/* Define SALLD Module as a master group in Doxygen format and add all SA LLD API
+   definitions to this group. */
+/** @defgroup salld_module SA LLD Module API
+ *  @{
+ *
+ *  Security Accelerator Low Level Driver
  *
  *   @section intro  Introduction
  *
@@ -78,6 +83,7 @@
  *   PA and/or CPPI and QMSS APIs to actually send the data to the SA sub-system.
  *
  */
+/* @} */
  
 #ifdef __cplusplus
 extern "C" {
@@ -112,13 +118,6 @@ extern "C" {
 #endif
 
 
-/* Define SALLD Module as a master group in Doxygen format and add all SA LLD API 
-   definitions to this group. */
-/** @defgroup salld_module SA LLD Module API
- *  @{
- */
-/** @} */
-   
 /** @defgroup salld_api_functions SA LLD Functions
  *  @ingroup salld_module
  */
@@ -857,7 +856,7 @@ typedef struct {
 #define sa_DM_CONFIG_SELECT_AIR_CIPHER_ENG  ((uint16_t) (0x0001U))
 
 /**
- *  @def  sa_DM_CONFIG_PROMOTE_NONSECURE
+ *  @def  sa_DM_CONFIG_PROMOTE_CHANNEL
  *        Control Info -- 1: promotion of normal world packet to secure packet
  *                           intended to land in the secure memory (only for sa2ul)
  *                        0: no promotion
@@ -871,7 +870,7 @@ typedef struct {
 #define sa_DM_CONFIG_PROMOTE_CHANNEL  ((uint16_t) (0x0002U))
 
 /**
- *  @def  sa_DM_CONFIG_DEMOTE_SECURE
+ *  @def  sa_DM_CONFIG_DEMOTE_CHANNEL
  *        Control Info -- 1: demotion of secure packet to normal world packet
  *                           intended to land in the secure memory (only for sa2ul)
  *                        0: no demotion
@@ -3293,7 +3292,7 @@ typedef struct {
 #define sa_RNG2_CTRL_REINIT        0x0001
 
 /**
- *  @def  sa_RNG_CTRL_RESET
+ *  @def  sa_RNG2_CTRL_RESET
  *        Control Info -- Set: RNG2 reset
  */
 #define sa_RNG2_CTRL_RESET         0x0002
@@ -4561,13 +4560,6 @@ typedef struct  {
 /*@{*/
 #define sa_PSINFO_FORMAT_CMD(x, offset, len)   ((x)->word[0] = (0x20000000UL | ((offset) << 16) | (len)))   /**< Format the PS Info header */
 #define sa_PSINFO_SET_COUNTC(x, countC)        ((x)->word[1] = (countC))                                    /**< Constructing Count-C */
-static inline void sa_PSINFO_SET_IV(Sa_psInfo_t *x, uint32_t *iv, int ivSize)                               /**< Constructing IV */
-{                                              
-    int i;                                       
-    x->word[0] |= ((ivSize + 8) << 24);    
-    for( i = 0; i < ivSize/4 ; i++)          
-        x->word[i+ 2] = iv[i];               
-} 
 /*@}*/
 /** @} */
 
@@ -4575,6 +4567,23 @@ static inline void sa_PSINFO_SET_IV(Sa_psInfo_t *x, uint32_t *iv, int ivSize)
 
 /*@}*/ /* @name SA LLD Macros */
 
+/**
+ *
+ *  @ingroup salld_api_macros
+ *  @brief sa_PSINFO_SET_IV: Constructing IV
+ *
+ *  @param[in]  x               pointer to PS Info data used by SASS
+ *  @param[in]  iv              pointer to IV
+ *  @param[in]  ivSize          size of the IV
+ *
+ */
+static inline void sa_PSINFO_SET_IV(Sa_psInfo_t *x, uint32_t *iv, int ivSize)
+{
+    int i;
+    x->word[0] |= ((ivSize + 8) << 24);
+    for( i = 0; i < ivSize/4 ; i++)
+        x->word[i+ 2] = iv[i];
+}
 
 /**   
  *  @page appendix1 3GPP Opeartion and PDU formats