mcuxClGlikey.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*/
/* Copyright 2022-2024 NXP                                                  */
/*                                                                          */
/* NXP Confidential and Proprietary. This software is owned or controlled   */
/* by NXP and may only be used strictly in accordance with the applicable   */
/* license terms.  By expressly accepting such terms or by downloading,     */
/* installing, activating and/or otherwise using the software, you are      */
/* agreeing that you have read, and that you agree to comply with and are   */
/* bound by, such license terms.  If you do not agree to be bound by the    */
/* applicable license terms, then you may not retain, install, activate or  */
/* otherwise use the software.                                              */
/*--------------------------------------------------------------------------*/

 
#ifndef MCUXCLGLIKEY_H_
#define MCUXCLGLIKEY_H_
 
#include <mcuxClConfig.h> // Exported features flags header
 
#include <stdint.h>
#include <stddef.h>
 
#include <mcuxCsslFlowProtection.h>
#include <mcuxClCore_FunctionIdentifiers.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
/**********************************************
 * CONSTANTS
 **********************************************/
 
/* [Design]
    Value: XX YZ UU VW
    - XX: F0: write to WR_EN1, 0F: do not write to WR_EN1
    - UU: F0: write to WR_EN0, 0F: do not write to WR_EN0
    - Y:  equal to <step> ^ W
    - Z:  value to write to WR_EN1 or equal to ~W
    - V:  equal to <step> ^ Z
    - W:  value to write to WR_EN0 or equal to ~Z
    Invariant: XXYZ ^ UUVW == 0xFFFF
*/
#define MCUXCLGLIKEY_CODEWORD_STEP1  ((uint32_t) 0xF0C10F3EU) 
#define MCUXCLGLIKEY_CODEWORD_STEP2  ((uint32_t) 0x0F1DF0E2U) 
#define MCUXCLGLIKEY_CODEWORD_STEP3  ((uint32_t) 0xF0B00F4FU) 
#define MCUXCLGLIKEY_CODEWORD_STEP4  ((uint32_t) 0x0F4EF0B1U) 
#define MCUXCLGLIKEY_CODEWORD_STEP5  ((uint32_t) 0xF0810F7EU) 
#define MCUXCLGLIKEY_CODEWORD_STEP6  ((uint32_t) 0x0F5DF0A2U) 
#define MCUXCLGLIKEY_CODEWORD_STEP7  ((uint32_t) 0xF0700F8FU) 
#define MCUXCLGLIKEY_CODEWORD_STEP_EN  ((uint32_t) 0x0FFFF000U) 
 
#define MCUXCLGLIKEY_STATUS_OK               0x0FF22E03u
#define MCUXCLGLIKEY_STATUS_NOT_LOCKED       0x0FF22E07u
#define MCUXCLGLIKEY_STATUS_LOCKED           0x0FF22E0Bu
 
#define MCUXCLGLIKEY_STATUS_VERSION_ERROR    0x0FF25334u
#define MCUXCLGLIKEY_STATUS_LOCKED_ERROR     0x0FF25338u
 
// Glikey state defines
#define MCUXCLGLIKEY_FSM_WR_DIS 0x0Bu
#define MCUXCLGLIKEY_FSM_INIT 0x16u
#define MCUXCLGLIKEY_FSM_STEP1 0x2Cu
#define MCUXCLGLIKEY_FSM_STEP2 0x58u
#define MCUXCLGLIKEY_FSM_STEP3 0xB0u
#define MCUXCLGLIKEY_FSM_STEP4 0x160u
#define MCUXCLGLIKEY_FSM_LOCKED 0xC01u
#define MCUXCLGLIKEY_FSM_WR_EN 0x1802u
#define MCUXCLGLIKEY_FSM_SSR_RESET 0x1005u

 
 
 
/**********************************************
 * TYPEDEFS
 **********************************************/
 
typedef uint32_t mcuxClGlikey_BaseAddress_t;
typedef uint32_t mcuxClGlikey_Status_t;
typedef uint32_t mcuxClGlikey_IntEnable_t;
typedef uint32_t mcuxClGlikey_GlikeyStatus_t;
 
/**********************************************
 * FUNCTIONS
 **********************************************/
 

MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_GetStatus)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_GetStatus(
    mcuxClGlikey_BaseAddress_t *     base,
    mcuxClGlikey_GlikeyStatus_t *    result
    );
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_SyncReset)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_SyncReset(
    mcuxClGlikey_BaseAddress_t *     base
    );

MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_SetIntEnable)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_SetIntEnable(
    mcuxClGlikey_BaseAddress_t *     base,
    mcuxClGlikey_IntEnable_t         value
    );

MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_GetIntEnable)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_GetIntEnable(
    mcuxClGlikey_BaseAddress_t *     base,
    mcuxClGlikey_IntEnable_t *       value
    );

MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_ClearIntStatus)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_ClearIntStatus(
    mcuxClGlikey_BaseAddress_t *     base
    );

MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_SetIntStatus)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_SetIntStatus(
    mcuxClGlikey_BaseAddress_t *     base
    );

MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_Lock)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_Lock(
    mcuxClGlikey_BaseAddress_t *     base
    );

MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_IsLocked)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_IsLocked(
    mcuxClGlikey_BaseAddress_t *     base
    );

MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_IsIndexLocked)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_IsIndexLocked(
    mcuxClGlikey_BaseAddress_t *     base,
    uint32_t                        index
    );

MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_StartEnable)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_StartEnable(
    mcuxClGlikey_BaseAddress_t *     base,
    uint32_t                        index
    );

/* [Design]
    - Check if Glikey is locked
        if ( GLIKEY_LOCKED == GLIKEY_GET_SFR_LOCK(base) ) return MCUXCLGLIKEY_STATUS_LOCKED_ERROR
    - Decode the codeword and write to Glikey CTRL[]
        EnableSelect = (XX - 0xF)%2
        EnableValue  = (XXYZUUVW >> (EnableSelect << 4))&3
        Write GLIKEY_CTRL(base, EnableSelect, EnableValue)
    - Return MCUXCLGLIKEY_STATUS_OK
*/
MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_ContinueEnable)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_ContinueEnable(
    mcuxClGlikey_BaseAddress_t *     base,
    uint32_t                        codeword
    );

MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_LockIndex)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_LockIndex(
    mcuxClGlikey_BaseAddress_t *     base
    );

MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_ResetIndex)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_ResetIndex(
    mcuxClGlikey_BaseAddress_t *     base,
    uint32_t                        index
    );
 
 

MCUX_CSSL_FP_FUNCTION_DECL(mcuxClGlikey_EndOperation)
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClGlikey_Status_t) mcuxClGlikey_EndOperation(
    mcuxClGlikey_BaseAddress_t *     base
    );
 

 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif // MCUXCLGLIKEY_H_