mcu/service/nvram/src/nvram_handler_startup.c

/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/

/*****************************************************************************
 *
 * Filename:
 * ---------
 * nvram_handler_startup.c
 *
 * Project:
 * --------
 *   MAUI
 *
 * Description:
 * ------------
 *   This is startup handler function of NVRAM module.
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 ****************************************************************************/
#include "kal_general_types.h"
#include "kal_public_api.h"
#include "nvram_msgid.h"

#include "kal_public_defs.h" //MSBB change #include "stack_config.h"

#include "nvram_main.h"
#include "nvram_data_items.h"
#include "us_timer.h"
#include "ex_public.h"

extern nvram_ee_info_type* nvram_ee_info;
extern kal_char nvram_trace_dump_temp_buffer[];
extern kal_char nvram_trace_dump_buffer[];
extern kal_mutexid g_nvram_dump_trace_mutex;
extern kal_wchar nvram_trace_filename[];
extern FS_HANDLE nvram_trace_file_hdl;
extern kal_uint32 nvram_trace_dump_buffer_offset;

extern module_type stack_get_active_module_id( void );


extern kal_int32 nvram_recover_data_item(nvram_ltable_entry_struct *ldi);


static void nvram_startup_confirm(
                module_type dest_id,
                nvram_errno_enum result,
                nvram_startup_req_struct *nvram_startup_req);

#if defined(__NVRAM_CRITICAL_DATA_SIGN_SUPPORT__)
kal_bool nvram_check_critcal_data_at_bootup()
{
    kal_bool chk_ret = KAL_FALSE;
        
    /* Read OEM critical data, and check signiture */
    chk_ret = custom_nvram_read_and_check_signed_critical_data();
    if (chk_ret == KAL_FALSE) {
        // try to restore LID from bin region, then re-check again
        nvram_ltable_entry_struct * ldi = NULL;
        
        nvram_util_get_data_item(&ldi, custom_nvram_get_signed_critical_data_lid());
        ASSERT(ldi != NULL);
        
        if (NVRAM_IS_CATEGORY_IN_BIN_REGION(ldi->category)) {
            if (nvram_recover_data_item(ldi) == NVRAM_IO_ERRNO_OK) {
                chk_ret = custom_nvram_read_and_check_signed_critical_data();
            }
        }
    }
    
    return chk_ret;
}
#endif

/*****************************************************************************
 * FUNCTION
 *  nvram_startup_handler
 * DESCRIPTION
 *  This is nvram_startup_handler() function of NVRAM module.
 * PARAMETERS
 *  ilm_ptr     [IN]        The primitives
 * RETURNS
 *  void
 *****************************************************************************/
void nvram_startup_handler(ilm_struct *ilm_ptr)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    nvram_startup_req_struct *nvram_startup_req;

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MD_TRC_FUNC_NVRAM_STARTUP();
    nvram_startup_req = (nvram_startup_req_struct*) ilm_ptr->local_para_ptr;

    NVRAM_EXT_ASSERT(nvram_startup_req != NULL,(kal_uint32)nvram_startup_req, NVRAM_LOC_STARTUP_REQ_PTR_IS_NULL_1, 0);
    /* Everything fine. */
    if (nvram_ptr->state == NVRAM_STATE_READY || nvram_ptr->state == NVRAM_STATE_NOT_READY)
    {
        MD_TRC_STATE_NVRAM_READY();

        nvram_ptr->state = NVRAM_STATE_READY;

        /* Check power-on mode */
        if (nvram_startup_req->poweron_mode == NVRAM_POWERON_NORMAL)
        {
            /* nvram_send_ilm(MOD_LAYER1); */
        }

#if defined(__NVRAM_CRITICAL_DATA_SIGN_SUPPORT__)
        if (ilm_ptr->src_mod_id == MOD_L4C) {
            if (nvram_check_critcal_data_at_bootup() != KAL_TRUE) {
                nvram_startup_confirm(ilm_ptr->src_mod_id, NVRAM_ERRNO_SIG_CHK_FAIL, nvram_startup_req);
                return;
            }
        }
#endif
        
        /* Finally, startup success.. */
        nvram_startup_confirm(ilm_ptr->src_mod_id, NVRAM_ERRNO_SUCCESS, nvram_startup_req);
    }
    /* Fatal error. */
    /* State error */
    else
    {
        MD_TRC_ERROR_NVRAM_STATE();

        nvram_startup_confirm(ilm_ptr->src_mod_id, NVRAM_ERRNO_FAIL, nvram_startup_req);
    }
}   /* end of nvram_startup_handler */


/*****************************************************************************
 * FUNCTION
 *  nvram_startup_confirm
 * DESCRIPTION
 *  This is nvram_startup_confirm() function of NVRAM module.
 * PARAMETERS
 *  dest_id                 [IN]        
 *  result                  [IN]        
 *  nvram_startup_req       [?]         
 *  ilm_ptr(?)              [IN]        The primitives
 * RETURNS
 *  void
 *****************************************************************************/
static void nvram_startup_confirm(
                module_type dest_id,
                nvram_errno_enum result,
                nvram_startup_req_struct *nvram_startup_req)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    nvram_startup_cnf_struct *nvram_startup_cnf;

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MD_TRC_FUNC_NVRAM_STARTUP_CNF(result);
    nvram_startup_cnf = (nvram_startup_cnf_struct*) construct_local_para(sizeof(nvram_startup_cnf_struct), TD_CTRL);

    /* Cylen, __FLIGHT_MODE_SUPPORT__ */
    if (result == NVRAM_ERRNO_SUCCESS)
    {
        /* read flight mode status */
        nvram_ltable_entry_struct *ldi;

        nvram_util_get_data_item(&ldi, NVRAM_EF_SYS_CACHE_OCTET_LID);
        result = nvram_read_data_item(ldi, NVRAM_SYS_FLIGHTMODE_STATE, 1, nvram_startup_cnf->data, NVRAM_EF_SYS_CACHE_OCTET_SIZE);
    }

    nvram_startup_cnf->result = result;
    nvram_startup_cnf->access_id = nvram_startup_req->access_id;

    nvram_send_ilm(dest_id, MSG_ID_NVRAM_STARTUP_CNF, nvram_startup_cnf, NULL);

    return;
}