MotorWare f2806x Driver API Documentation
Data Structures | Macros | Typedefs | Enumerations | Functions
pwr.h File Reference

Contains public interface to various functions related to the power (PWR) object. More...

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

Go to the source code of this file.

Data Structures

struct  _PWR_Obj_
 Defines the power (PWR) object. More...
 

Macros

#define PWR_BASE_ADDR   (0x00000985)
 Defines the base address of the power (PWR) registers. More...
 
#define PWR_BORCFG_BORENZ_BITS   (1 << 0)
 Defines the location of the BORENZ bits in the BORCFG register. More...
 
#define PWR_LPMCR0_LPM_BITS   (3 << 0)
 Defines the location of the LPM bits in the LPMCR0 register. More...
 
#define PWR_LPMCR0_QUALSTDBY_BITS   (63 << 2)
 Defines the location of the QUALSTDBY bits in the LPMCR0 register. More...
 
#define PWR_LPMCR0_WDINTE_BITS   (1 << 15)
 Defines the location of the WDINTE bits in the LPMCR0 register. More...
 

Typedefs

typedef struct _PWR_Obj_ PWR_Obj
 Defines the power (PWR) object. More...
 
typedef struct _PWR_Obj_PWR_Handle
 Defines the power (PWR) handle. More...
 

Enumerations

enum  PWR_LowPowerMode_e { PWR_LowPowerMode_Idle =0, PWR_LowPowerMode_Standby, PWR_LowPowerMode_Halt }
 Enumeration to define the power (PWR) low power modes. More...
 
enum  PWR_NumStandByClocks_e {
  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)
}
 Enumeration to define the power (PWR) number of standby clock cycles. More...
 

Functions

void PWR_disableBrownOutReset (PWR_Handle pwrHandle)
 Disables the brownout reset functions. More...
 
void PWR_disableWatchDogInt (PWR_Handle pwrHandle)
 Disables the watchdog interrupt. More...
 
void PWR_enableBrownOutReset (PWR_Handle pwrHandle)
 Enables the brownout reset functions. More...
 
void PWR_enableWatchDogInt (PWR_Handle pwrHandle)
 Enables the watchdog interrupt. More...
 
PWR_Handle PWR_init (void *pMemory, const size_t numBytes)
 Initializes the power (PWR) object handle. More...
 
void PWR_setLowPowerMode (PWR_Handle pwrHandle, const PWR_LowPowerMode_e lowPowerMode)
 Sets the low power mode. More...
 
void PWR_setNumStandByClocks (PWR_Handle pwrHandle, const PWR_NumStandByClocks_e numClkCycles)
 Sets the number of standby clock cycles. More...
 

Detailed Description

Contains public interface to various functions related to the power (PWR) object.

(C) Copyright 2015, Texas Instruments, Inc.

Definition in file pwr.h.