ptxNSC_System.h

Go to the documentation of this file.

 
#ifndef PTXNSC_SYSTEM_H_
#define PTXNSC_SYSTEM_H_
 
#include "ptxStatus.h"
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES / INTERNALS
 * ####################################################################################################################
 */
 
# define SYSTEM_CFG_TAG_VERSION                         (0x00U)                                    
# define SYSTEM_CFG_TAG_PA_OVERCURRENT_TH               (0x01U)                                    
# define SYSTEM_CFG_TAG_PA_TEMPERATURE_TH               (0x02U)                                    
# define SYSTEM_CFG_TAG_CON_CLK_SOURCE                  (0x03U)                                    
# define SYSTEM_CFG_TAG_CON_VAR_LBS                     (0x04U)                                    
# define SYSTEM_CFG_TAG_CON_NHOST                       (0x05U)                                    
# define SYSTEM_CFG_TAG_CON_NHOST_CE                    (0x06U)                                    
# define SYSTEM_DEFAULT_VERSION                         (0x10U)                                    
# define SYSTEM_DEFAULT_PA_OVERCURRENT_TH               (0x04U)                                    
# define SYSTEM_DEFAULT_PA_TEMPERATURE_TH               (0xFFU)                                    
# define SYSTEM_DEFAULT_CON_CLK_SOURCE                  (0x00U)                                    
# define SYSTEM_DEFAULT_CON_VAR_LBS                     (0x20U)                                    
static const uint8_t SYSTEM_DEFAULT_CON_NHOST[4]        = {0x78U, 0x00U, 0x00U, 0x00U};            
static const uint8_t SYSTEM_DEFAULT_CON_NHOST_CE[4]     = {0x78U, 0x40U, 0x00U, 0x00U};            
/*
 * Forward declaration
 */
struct ptxNSC_System;
struct ptxNSC;
 
typedef struct ptxNSC_System
{
    uint8_t Version;                        
    uint8_t UseExtCfg;                      
    uint8_t PowerAmpTempThreshold;          
    uint8_t PowerAmpOverCurrThreshold;      
    uint8_t ConClkSource;                   
    uint8_t ConVarLBS;                      
    uint8_t conHost[4];                     
    uint8_t conHostCE[4];                   
} ptxNSC_System_t;
 
 
/*
 * ####################################################################################################################
 * FUNCTIONS API.
 * ####################################################################################################################
 */
 
ptxStatus_t ptxNSC_System_SetConfig (struct ptxNSC *nscCtx, ptxNSC_System_t *sysParams);
 
ptxStatus_t ptxNSC_System_GetConfig (struct ptxNSC *nscCtx, ptxNSC_System_t *sysParams);
 
ptxStatus_t ptxNSC_System_ApplyDefaults (struct ptxNSC *nscCtx);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */