MotorWare f2806x Driver API Documentation

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

Data Structures | Macros | Typedefs | Enumerations | Functions
osc.h File Reference

Contains public interface to various functions related to the oscillator (OSC) object. More...

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

Go to the source code of this file.

## Data Structures
struct | _OSC_Obj_
| Defines the oscillator (OSC) object. More...

## Macros
#define | OSC_BASE_ADDR (0x00007014)
| Defines the base address of the oscillator (OSC) registers. More...
#define | OSC_INTOSCnTRIM_COARSE_BITS (255 << 0)
| Defines the location of the COARSETRIM bits in the INTOSCnTRIM register. More...
#define | OSC_INTOSCnTRIM_FINE_BITS (63 << 9)
| Defines the location of the FINETRIM bits in the INTOSCnTRIM register. More...

## Typedefs
typedef struct _OSC_Obj_ | OSC_Obj
| Defines the oscillator (OSC) object. More...
typedef struct _OSC_Obj_ * | OSC_Handle
| Defines the oscillator (OSC) handle. More...

## Enumerations
enum | OSC_Src_e { OSC_Src_Internal =(0 << 0), OSC_Src_External =(1 << 0) }
| Enumeration to define the oscillator (OSC) source. More...
enum | OSC_Osc2Src_e { OSC_Osc2Src_Internal =(0 << 1), OSC_Osc2Src_External =(1 << 1) }
| Enumeration to define the oscillator (OSC) 2 source. More...
enum | OSC_Number_e { OSC_Number_1 =1, OSC_Number_2 }
| Enumeration to define the oscillator (OSC) number. More...

## Functions
OSC_Handle | OSC_init (void *pMemory, const size_t numBytes)
| Initializes the oscillator (OSC) handle. More...
void | OSC_setCoarseTrim (OSC_Handle clkHandle, const OSC_Number_e oscNumber, const uint_least8_t trimValue)
| Sets the coarse trim value for a specified oscillator. More...
void | OSC_setFineTrim (OSC_Handle clkHandle, const OSC_Number_e oscNumber, const uint_least8_t trimValue)
| Sets the fine trim value for a specified oscillator. More...
void | OSC_setTrim (OSC_Handle clkHandle, const OSC_Number_e oscNumber, const uint16_t trimValue)
| Sets the trim value for a specified oscillator. More...

## Detailed Description

Contains public interface to various functions related to the oscillator (OSC) object.

(C) Copyright 2015, Texas Instruments, Inc.

Definition in file osc.h.