/*
 * Copyright (c) 2013-2015 Travis Geiselbrecht
 *
 * Use of this source code is governed by a MIT-style
 * license that can be found in the LICENSE file or at
 * https://opensource.org/licenses/MIT
 */
#pragma once

#include <lk/compiler.h>
#include <sys/types.h>

__BEGIN_CDECLS

/*
 * LK's init system
 */

typedef void (*lk_init_hook)(uint level);

enum lk_init_level {
    LK_INIT_LEVEL_EARLIEST = 1,

    LK_INIT_LEVEL_ARCH_EARLY     = 0x1000,
    LK_INIT_LEVEL_PLATFORM_EARLY = 0x2000,
    LK_INIT_LEVEL_TARGET_EARLY   = 0x3000,
    LK_INIT_LEVEL_HEAP           = 0x4000,
    LK_INIT_LEVEL_VM             = 0x5000,
    LK_INIT_LEVEL_KERNEL         = 0x6000,
    LK_INIT_LEVEL_THREADING      = 0x7000,
    LK_INIT_LEVEL_ARCH           = 0x8000,
    LK_INIT_LEVEL_PLATFORM       = 0x9000,
    LK_INIT_LEVEL_TARGET         = 0xa000,
    LK_INIT_LEVEL_APPS           = 0xb000,

    LK_INIT_LEVEL_LAST = UINT16_MAX,
};

enum lk_init_flags {
    LK_INIT_FLAG_PRIMARY_CPU     = 0x1,
    LK_INIT_FLAG_SECONDARY_CPUS  = 0x2,
    LK_INIT_FLAG_ALL_CPUS        = LK_INIT_FLAG_PRIMARY_CPU | LK_INIT_FLAG_SECONDARY_CPUS,
    LK_INIT_FLAG_CPU_SUSPEND     = 0x4,
    LK_INIT_FLAG_CPU_RESUME      = 0x8,
};

// Run init hooks between start_level (inclusive) and stop_level (exclusive) that match the required_flags.
void lk_init_level(enum lk_init_flags required_flags, uint16_t start_level, uint16_t stop_level);

static inline void lk_primary_cpu_init_level(uint16_t start_level, uint16_t stop_level) {
    lk_init_level(LK_INIT_FLAG_PRIMARY_CPU, start_level, stop_level);
}

static inline void lk_init_level_all(enum lk_init_flags flags) {
    lk_init_level(flags, LK_INIT_LEVEL_EARLIEST, LK_INIT_LEVEL_LAST);
}

struct lk_init_struct {
    uint16_t level;
    uint16_t flags;
    lk_init_hook hook;
    const char *name;
};

// Define an init hook with specific flags, level, and name.
#define LK_INIT_HOOK_FLAGS(_name, _hook, _level, _flags) \
    static const struct lk_init_struct _init_struct_##_name __ALIGNED(sizeof(void *)) __SECTION("lk_init") = { \
        .level = (_level), \
        .flags = (_flags), \
        .hook = (_hook), \
        .name = #_name, \
    };

// Shortcut for defining an init hook with primary CPU flag.
#define LK_INIT_HOOK(_name, _hook, _level) \
    LK_INIT_HOOK_FLAGS(_name, _hook, _level, LK_INIT_FLAG_PRIMARY_CPU)

__END_CDECLS