los_runstop.h

浏览该文件的文档.

/* ----------------------------------------------------------------------------
 * Copyright (c) Huawei Technologies Co., Ltd. 2013-2019. All rights reserved.
 * Description: Runstop HeadFile
 * Author: Huawei LiteOS Team
 * Create: 2013-01-01
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright notice, this list of
 * conditions and the following disclaimer.
 * 2. 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.
 * 3. Neither the name of the copyright holder 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 HOLDER 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.
 * --------------------------------------------------------------------------- */
 
#ifndef _LOS_RUNSTOP_H
#define _LOS_RUNSTOP_H
 
#include "los_typedef.h"
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
typedef VOID (*RUNSTOP_CALLBACK_FUNC)(VOID);
 
typedef INT32 (*FLASH_READ_FUNC)(VOID *memAddr, size_t start, size_t size);
 
typedef INT32 (*FLASH_WRITE_FUNC)(VOID *memAddr, size_t start, size_t size);
 
typedef struct tagRunstopParam {
    RUNSTOP_CALLBACK_FUNC pfIdleWakeupCallback; /* < Wake up callback function, called in idle task */
    RUNSTOP_CALLBACK_FUNC pfWakeupCallback;     /* < Wake up callback function */
    RUNSTOP_CALLBACK_FUNC pfImageDoneCallback;  /* < Image done callback function, called just after memory is stored */
    FLASH_READ_FUNC pfFlashReadFunc;            /* < An abstract function for reading data from a certain flash */
    FLASH_WRITE_FUNC pfFlashWriteFunc;          /* < An abstract function for writing data to a certain flash */
    size_t uwFlashReadAlignSize;                /* < Block align size when reading data from a certain flash */
    size_t uwFlashEraseAlignSize;               /* < Block align size when erasing data in a certain flash */
    size_t uwFlashWriteAlignSize;               /* < Block align size when writing data to a certain flash */
    UINTPTR uwWowFlashAddr;                     /* < The flash starting address to which the memory is to be
                                                     stored, the address should be flash write-alignment length
                                                     aligned */
    UINTPTR uwImageFlashAddr;                   /* < The flash starting address where the whole application image
                                                     is burned */
} RUNSTOP_PARAM_S;
 
extern VOID LOS_MakeImage(const RUNSTOP_PARAM_S *runstopParam);
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif /* _LOS_RUNSTOP_H */