source: svn/trunk/newcon3bcm2_21bu/rockford/bsp/AVS/src/avs_start.c

/***************************************************************************
 *     Copyright (c) 2008-2013, Broadcom Corporation
 *     All Rights Reserved
 *     Confidential Property of Broadcom Corporation
 *
 *  THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE
 *  AGREEMENT  BETWEEN THE USER AND BROADCOM.  YOU HAVE NO RIGHT TO USE OR
 *  EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT.
 *
 * $brcm_Workfile: avs_start.c $
 * $brcm_Revision: Hydra_Software_Devel/4 $
 * $brcm_Date: 1/23/13 5:11p $
 *
 * Module Description:
 *
 * Revision History:
 *
 * $brcm_Log: /rockford/bsp/AVS/src/avs_start.c $
 * 
 * Hydra_Software_Devel/4   1/23/13 5:11p rjlewis
 * SWCFE-968: enable the call to check in the reset            the reset.
 * 
 * Hydra_Software_Devel/3   1/22/13 4:47p rjlewis
 * SWCFE-986: Enabled temperature over                over-temperature
 * reset by default.  Enabled over-temperature reset detection and print
 * (by default).
 * 
 * Hydra_Software_Devel/2   8/2/12 1:13p garylin
 * SWCFE-897: Update AVS to version 0.5.4
 * 
***************************************************************************/

#include <stdint.h>
#include <stdbool.h>
#include "avs_settings.h"
#include "bchp_avs_hw_mntr.h"
#include "bchp_aon_ctrl.h"

#define SCALING_FACTOR 10000 /* make this larger to get more precision in the numbers (but be careful of overflow) */
#define S1 SCALING_FACTOR    /* WARNING: DO NOT CHANGE THIS -- it MUST match the definition used to build the library */
#define S2 SCALING_FACTOR
#define INT(x) ((int32_t)((x)*S1)) /* this creates an integer from a float with the precision defined above */

/* WARNING: the items below are values that were lab tested and should NOT be changed unless instructed to do so. */
/* Changing these values can result in system failures (chip resets, memory read/write errors, hangs, etc.). */

/* Margins added to the initial voltage setting to ensure adaquite voltage across all types of parts */
#define VMARGINL            INT(.150) /*150mV*/
#define VMARGINH            INT(.100) /*100mV*/

/* Minimum/maximum voltage settings allowed when setting the initial voltage */
#define VMIN_AVS            INT(.860) /*0.860V*/
#define VMAX_AVS            INT(1.02) /*1.020V*/

/* Maximum supported temperature if Temperature Threshold option is used */
#define MAX_TEMPERATURE 130 /* note: 150C = register value of 0x1E2 which is the default for this register */

/* Allow the values above to be over-ridden in the Makefile for test purposes (special builds) */
#ifdef AVS_MARGIN_LOW
#undef  VMARGINL
#define VMARGINL            (INT(AVS_MARGIN_LOW))
#endif
#ifdef AVS_MARGIN_HIGH
#undef  VMARGINH
#define VMARGINH            (INT(AVS_MARGIN_HIGH))
#endif
#ifdef AVS_MIN_AVS
#undef  VMIN_AVS
#define VMIN_AVS            (INT(AVS_MIN_AVS))
#endif
#ifdef AVS_MAX_AVS
#undef  VMAX_AVS
#define VMAX_AVS            (INT(AVS_MAX_AVS))
#endif

#ifdef AVS_MAX_TEMPERATURE 
#undef MAX_TEMPERATURE
#define MAX_TEMPERATURE AVS_MAX_TEMPERATURE
#endif

#ifdef AVS_NO_PRINTS
#define QUIET 1 /* set to 1 for production release */
#else
#define QUIET 0 /* default is to print minimal data */
#endif

/* Some customer builds required added delay after changing the DAC (before reading the voltage) to allow regulator to settle */
#ifdef AVS_EXTRA_DELAY
#define EXTRA_DELAY AVS_EXTRA_DELAY
#else
#define EXTRA_DELAY 0
#endif

//#define AVS_DEBUG_STARTUP /* enable this to include debug code */

#ifdef AVS_DEBUG_STARTUP
#include "avs_debug.c"
#endif

#define BREG_Write32(addr,value) do { *(volatile uint32_t*)(addr+0xB0000000)=(value); } while(0)
#define BREG_Read32(addr)            (*(volatile uint32_t*)(addr+0xB0000000))

/*\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\*/

#ifndef INCLUDE_TEMPERATURE_THRESHOLD
#define INCLUDE_TEMPERATURE_THRESHOLD /* enable to set a temperature threshold to cause a reset for over-temp */
#endif

#ifdef INCLUDE_TEMPERATURE_THRESHOLD
/* This enables a fail-safe temperature monitor.  If the temperature ever reaches this value the part will reset.
** There This is really just a last ditch effort to save the part from burning up.
** Note: 
**   reg = BREG_Read32(BCHP_AVS_RO_REGISTERS_0_PVT_TEMPERATURE_MNTR_STATUS);
**   reg &= BCHP_AVS_RO_REGISTERS_0_PVT_TEMPERATURE_MNTR_STATUS_data_MASK;
**   temperature = 418*1000 - (556 * reg);
** Note that the part is guaranteed to run up to 125C so using 150C is just to catch run-away temperature situations.
** The result of a reset due to over-temp can be read in "BCHP_AON_CTRL_RESET_HISTORY" with bit: AON_CTRL :: RESET_HISTORY :: overtemp_reset [13:13]
*/
static inline void AvsSetTempThreshold(void)
{
        uint32_t reg = (418 - MAX_TEMPERATURE) * 1000 / 556;
        BREG_Write32(BCHP_AVS_HW_MNTR_TEMPERATURE_THRESHOLD, reg); 
        BREG_Write32(BCHP_AVS_HW_MNTR_TEMPERATURE_RESET_ENABLE, 1);
}

#ifndef INCLUDE_TEMPERATURE_RESET_PRINT
#define INCLUDE_TEMPERATURE_RESET_PRINT /* enable to print message when temperature reset occurred */
#endif

#ifdef INCLUDE_TEMPERATURE_RESET_PRINT
/* This can be used to verify that reset occured due to over-temp */
static inline void AvsCheckTempReset(void)
{
        uint32_t reg;
        extern void print_char(char c);
        extern void print_hex32(uint32_t val);

        reg = BREG_Read32(BCHP_AON_CTRL_RESET_HISTORY);
        //print_char('R');print_char('=');print_hex32(reg);print_char(0xa);print_char(0xd);

        if (reg & BCHP_AON_CTRL_RESET_HISTORY_overtemp_reset_MASK) {
                print_char('O');        
                print_char('v');        
                print_char('e');        
                print_char('r');        
                print_char('-');        
                print_char('t');        
                print_char('e');        
                print_char('m');        
                print_char('p');        
                print_char(' ');        
                print_char('R');        
                print_char('e');        
                print_char('s');        
                print_char('e');        
                print_char('t');        
                print_char('!');        
                print_char(0xa); print_char(0xd);

                /* Clear the reset history for the next reboot */
                BREG_Write32(BCHP_AON_CTRL_RESET_CTRL, 1);
                BREG_Write32(BCHP_AON_CTRL_RESET_CTRL, 0);
        }
}
#endif /*INCLUDE_TEMPERATURE_RESET_PRINT*/
#endif /*INCLUDE_TEMPERATURE_THRESHOLD*/

/*\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\//\\*/

/* This is the main entry point for AVS processing */

void AvsStart(void)
{
        run_time_params params;

        params.vmargin_low  = VMARGINL;
        params.vmargin_high = VMARGINH;
        params.voltage_min_avs = VMIN_AVS; 
        params.voltage_max_avs = VMAX_AVS; 
        params.extra_delay = EXTRA_DELAY;
        params.quiet = QUIET; 

#ifdef INCLUDE_TEMPERATURE_RESET_PRINT
        AvsCheckTempReset();
#endif

        AvsLibraryStart(&params);

#ifdef INCLUDE_TEMPERATURE_THRESHOLD
        AvsSetTempThreshold();
#endif
}

void AvsWarmStart(void)
{ 
#if BCHP_CHIP==7358
        /* 7358 doesn't have AON registers so can't restore anything saved -- just handle it like startup */
        /* This has to be handled here because binary doesn't know the defaults we're using for parameters */
        AvsStart();
#else
        AvsLibraryWarmStart(EXTRA_DELAY);
#endif
}