src/bsp/lk/app/blxboot/blxboot_plat.h

/*
 * Copyright (c) 2019 MediaTek Inc.
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files
 * (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

#pragma once

#include <lib/android_dtbo.h>
#include <stddef.h>

/*
 * plat_start_scpsys() - start scpsys processor
 *
 * blxboot has only weak imp., override this function if necessary.
 */
void plat_start_scpsys(void);

/*
 * plat_fixup_init() - init platform fixup stuff
 *
 * blxboot has only weak imp. override this function if necessary.
 *
 * return:
 *     NO_ERROR, on success
 *     otherwise, on failure
 */
int plat_fixup_init(void);

/*
 * plat_fixup_append() - append string for platform fixup
 *
 * blxboot has only weak imp. override this function if necessary.
 *
 * @append_str: the string to be appended to kernel command line
 */
void plat_fixup_append(char *append_str);

/*
 * plat_fixup_hook() - platform fixup hook function
 *
 * blxboot has only weak imp. override this function if necessary.
 *
 * @boot_mode: current boot mode, one of NORMAL_BOOT, RECOVERY_BOOT and
 *             FASTBOOT_BOOT
 * @ab_suffix: pointer to ab boot suffix string, could be NULL if ab is
 *             not enabled
 * @dtb:       pointer to the device tree blob
 * @dtb_size:  the maximum size of dtb
 */
void plat_fixup_hook(uint32_t boot_mode, const char *ab_suffix,
                     void *dtb, size_t dtb_size);

/*
 * plat_compare_dtbo_hwinfo() - platform defined dtbo hardware information
 *                              comparison function
 *
 * blxboot has only weak imp., override this function if necessary.
 *
 * @dtbo_version: android dtbo format version
 * @entry: pointer to the table entry which contains the id, rev, and custom
 *         information for matching the dtbo to current hardware configuration
 *
 * return:
 *     0, on success (entry selected)
 *     -1, on failure
 */
int plat_compare_dtbo_hwinfo(uint32_t dtbo_version,
                             struct dt_table_entry *entry);