osc.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 _OSC_H_
#define _OSC_H_



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

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


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




#ifdef __cplusplus
extern "C" {
#endif


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


#define  OSC_BASE_ADDR                   (0x00007014)


#define  OSC_INTOSCnTRIM_COARSE_BITS     (255 << 0)

#define  OSC_INTOSCnTRIM_FINE_BITS       (63 << 9)


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


typedef enum
{
  OSC_Src_Internal=(0 << 0),  
  OSC_Src_External=(1 << 0)   
} OSC_Src_e;


typedef enum
{
  OSC_Osc2Src_Internal=(0 << 1),  
  OSC_Osc2Src_External=(1 << 1)   
} OSC_Osc2Src_e;


typedef enum
{
  OSC_Number_1=1,  
  OSC_Number_2     
} OSC_Number_e;


typedef struct _OSC_Obj_
{
    volatile uint16_t   INTOSC1TRIM;  
    volatile uint16_t   rsvd_1;       
    volatile uint16_t   INTOSC2TRIM;  
} OSC_Obj;


typedef struct _OSC_Obj_ *OSC_Handle;


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


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



extern OSC_Handle OSC_init(void *pMemory,const size_t numBytes);


extern void OSC_setCoarseTrim(OSC_Handle clkHandle,
                              const OSC_Number_e oscNumber,
                              const uint_least8_t trimValue);


extern void OSC_setFineTrim(OSC_Handle clkHandle,
                            const OSC_Number_e oscNumber,
                            const uint_least8_t trimValue);


extern void OSC_setTrim(OSC_Handle clkHandle,
                        const OSC_Number_e oscNumber,
                        const uint16_t trimValue);


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

#endif  // end of _OSC_H_ definition