pwr.h

Go to the documentation of this file.

/* --COPYRIGHT--,BSD
 * Copyright (c) 2015, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * --/COPYRIGHT--*/
#ifndef _PWR_H_
#define _PWR_H_


// **************************************************************************
// the includes

#include "sw/modules/types/src/types.h"

#include "sw/drivers/cpu/src/32b/f28x/f2806x/cpu.h"





#ifdef __cplusplus
extern "C" {
#endif


// **************************************************************************
// the defines


#define PWR_BASE_ADDR              (0x00000985)


#define PWR_BORCFG_BORENZ_BITS     (1 << 0)


#define PWR_LPMCR0_LPM_BITS        (3 << 0)

#define PWR_LPMCR0_QUALSTDBY_BITS  (63 << 2)

#define PWR_LPMCR0_WDINTE_BITS     (1 << 15)


// **************************************************************************
// the typedefs

typedef enum
{
    PWR_LowPowerMode_Idle=0,    
    PWR_LowPowerMode_Standby,   
    PWR_LowPowerMode_Halt       
} PWR_LowPowerMode_e;


typedef enum
{
    PWR_NumStandByClocks_2=(0 << 2),    
    PWR_NumStandByClocks_3=(1 << 2),    
    PWR_NumStandByClocks_4=(2 << 2),    
    PWR_NumStandByClocks_5=(3 << 2),    
    PWR_NumStandByClocks_6=(4 << 2),    
    PWR_NumStandByClocks_7=(5 << 2),    
    PWR_NumStandByClocks_8=(6 << 2),    
    PWR_NumStandByClocks_9=(7 << 2),    
    PWR_NumStandByClocks_10=(8 << 2),   
    PWR_NumStandByClocks_11=(9 << 2),   
    PWR_NumStandByClocks_12=(10 << 2),  
    PWR_NumStandByClocks_13=(11 << 2),  
    PWR_NumStandByClocks_14=(12 << 2),  
    PWR_NumStandByClocks_15=(13 << 2),  
    PWR_NumStandByClocks_16=(14 << 2),  
    PWR_NumStandByClocks_17=(15 << 2),  
    PWR_NumStandByClocks_18=(16 << 2),  
    PWR_NumStandByClocks_19=(17 << 2),  
    PWR_NumStandByClocks_20=(18 << 2),  
    PWR_NumStandByClocks_21=(19 << 2),  
    PWR_NumStandByClocks_22=(20 << 2),  
    PWR_NumStandByClocks_23=(21 << 2),  
    PWR_NumStandByClocks_24=(22 << 2),  
    PWR_NumStandByClocks_25=(23 << 2),  
    PWR_NumStandByClocks_26=(24 << 2),  
    PWR_NumStandByClocks_27=(25 << 2),  
    PWR_NumStandByClocks_28=(26 << 2),  
    PWR_NumStandByClocks_29=(27 << 2),  
    PWR_NumStandByClocks_30=(28 << 2),  
    PWR_NumStandByClocks_31=(29 << 2),  
    PWR_NumStandByClocks_32=(30 << 2),  
    PWR_NumStandByClocks_33=(31 << 2),  
    PWR_NumStandByClocks_34=(32 << 2),  
    PWR_NumStandByClocks_35=(33 << 2),  
    PWR_NumStandByClocks_36=(34 << 2),  
    PWR_NumStandByClocks_37=(35 << 2),  
    PWR_NumStandByClocks_38=(36 << 2),  
    PWR_NumStandByClocks_39=(37 << 2),  
    PWR_NumStandByClocks_40=(38 << 2),  
    PWR_NumStandByClocks_41=(39 << 2),  
    PWR_NumStandByClocks_42=(40 << 2),  
    PWR_NumStandByClocks_43=(41 << 2),  
    PWR_NumStandByClocks_44=(42 << 2),  
    PWR_NumStandByClocks_45=(43 << 2),  
    PWR_NumStandByClocks_46=(44 << 2),  
    PWR_NumStandByClocks_47=(45 << 2),  
    PWR_NumStandByClocks_48=(46 << 2),  
    PWR_NumStandByClocks_49=(47 << 2),  
    PWR_NumStandByClocks_50=(48 << 2),  
    PWR_NumStandByClocks_51=(49 << 2),  
    PWR_NumStandByClocks_52=(50 << 2),  
    PWR_NumStandByClocks_53=(51 << 2),  
    PWR_NumStandByClocks_54=(52 << 2),  
    PWR_NumStandByClocks_55=(53 << 2),  
    PWR_NumStandByClocks_56=(54 << 2),  
    PWR_NumStandByClocks_57=(55 << 2),  
    PWR_NumStandByClocks_58=(56 << 2),  
    PWR_NumStandByClocks_59=(57 << 2),  
    PWR_NumStandByClocks_60=(58 << 2),  
    PWR_NumStandByClocks_61=(59 << 2),  
    PWR_NumStandByClocks_62=(60 << 2),  
    PWR_NumStandByClocks_63=(61 << 2),  
    PWR_NumStandByClocks_64=(62 << 2),  
    PWR_NumStandByClocks_65=(63 << 2)   
} PWR_NumStandByClocks_e;


typedef struct _PWR_Obj_
{
    volatile uint16_t   BORCFG;          
    volatile uint16_t   rsvd_1[26264];   //<! Reserved
    volatile uint16_t   LPMCR0;          //<! Low Power Mode Control Register 0
} PWR_Obj;


typedef struct _PWR_Obj_ *PWR_Handle;


// **************************************************************************
// the globals


// **************************************************************************
// the function prototypes


extern void PWR_disableBrownOutReset(PWR_Handle pwrHandle);


extern void PWR_disableWatchDogInt(PWR_Handle pwrHandle);


extern void PWR_enableBrownOutReset(PWR_Handle pwrHandle);


extern void PWR_enableWatchDogInt(PWR_Handle pwrHandle);


extern PWR_Handle PWR_init(void *pMemory,const size_t numBytes);


extern void PWR_setLowPowerMode(PWR_Handle pwrHandle,const PWR_LowPowerMode_e lowPowerMode);


extern void PWR_setNumStandByClocks(PWR_Handle pwrHandle,const PWR_NumStandByClocks_e numClkCycles);


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

#endif  // end of _PWR_H_ definition