mirror of
https://github.com/Telecominfraproject/OpenCellular.git
synced 2025-12-29 10:00:51 +00:00
8cb10aaf5b
This adds a new hook that is intended to be called immediately before host chipset/AP startup to initialize components such as the PMU. Signed-off-by: David Hendricks <dhendrix@chromium.org> BRANCH=snow BUG=chrome-os-partner:13315 TEST=tested in subsequent patches Change-Id: I2b38208de9f0f51abc0b22c49547ee0c4c889b82 Reviewed-on: https://gerrit.chromium.org/gerrit/31738 Reviewed-by: Charlie Mooney <charliemooney@chromium.org> Reviewed-by: Vincent Palatin <vpalatin@chromium.org> Commit-Ready: David Hendricks <dhendrix@chromium.org> Tested-by: David Hendricks <dhendrix@chromium.org>
79 lines
2.9 KiB
C
79 lines
2.9 KiB
C
/* Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
|
|
* Use of this source code is governed by a BSD-style license that can be
|
|
* found in the LICENSE file.
|
|
*/
|
|
|
|
/* System hooks for Chrome EC */
|
|
|
|
#ifndef __CROS_EC_HOOKS_H
|
|
#define __CROS_EC_HOOKS_H
|
|
|
|
#include "common.h"
|
|
|
|
enum hook_priority {
|
|
/* Generic values across all hooks */
|
|
HOOK_PRIO_FIRST = 1, /* Highest priority */
|
|
HOOK_PRIO_DEFAULT = 5000, /* Default priority */
|
|
HOOK_PRIO_LAST = 9999, /* Lowest priority */
|
|
|
|
/* Specific hook vales for HOOK_INIT */
|
|
/* LPC inits before modules which need memory-mapped I/O */
|
|
HOOK_PRIO_INIT_LPC = HOOK_PRIO_FIRST + 1,
|
|
/* Chipset inits before modules which need to know its initial state. */
|
|
HOOK_PRIO_INIT_CHIPSET = HOOK_PRIO_FIRST + 2,
|
|
};
|
|
|
|
|
|
enum hook_type {
|
|
HOOK_INIT = 0, /* System init */
|
|
HOOK_FREQ_CHANGE, /* System clock changed frequency */
|
|
HOOK_SYSJUMP, /* About to jump to another image. Modules
|
|
* which need to preserve data across such a
|
|
* jump should save it here and restore it in
|
|
* HOOK_INIT.
|
|
*
|
|
* NOTE: This hook is called with interrupts
|
|
* disabled! */
|
|
HOOK_CHIPSET_PRE_INIT, /* Initialization for components such as PMU to
|
|
* be done before host chipset/AP starts up. */
|
|
HOOK_CHIPSET_STARTUP, /* System is starting up. All suspend rails are
|
|
* now on. */
|
|
HOOK_CHIPSET_RESUME, /* System is resuming from suspend, or booting
|
|
* and has reached the point where all voltage
|
|
* rails are on */
|
|
HOOK_CHIPSET_SUSPEND, /* System is suspending, or shutting down; all
|
|
* voltage rails are still on */
|
|
HOOK_CHIPSET_SHUTDOWN, /* System is shutting down. All suspend rails
|
|
* are still on. */
|
|
HOOK_AC_CHANGE, /* AC power plugged in or removed */
|
|
HOOK_LID_CHANGE, /* Lid opened or closed. Based on debounced lid
|
|
* state, not raw lid GPIO input. */
|
|
};
|
|
|
|
|
|
struct hook_data {
|
|
/* Hook processing routine; returns EC error code. */
|
|
int (*routine)(void);
|
|
/* Priority; low numbers = higher priority. */
|
|
int priority;
|
|
};
|
|
|
|
|
|
/* Call all the hook routines of a specified type. If stop_on_error, stops on
|
|
* the first non-EC_SUCCESS return code. Returns the first non-EC_SUCCESS
|
|
* return code, if any, or EC_SUCCESS if all hooks returned EC_SUCCESS. */
|
|
int hook_notify(enum hook_type type, int stop_on_error);
|
|
|
|
|
|
/* Register a hook routine. <hooktype> should be one of enum hook_type.
|
|
* <routine> should be int routine(void), and should return an error code or
|
|
* EC_SUCCESS if no error. <priority> should be between HOOK_PRIO_FIRST and
|
|
* HOOK_PRIO_LAST, and should be HOOK_PRIO_DEFAULT unless there's a compelling
|
|
* reason to care about the order in which hooks are called. */
|
|
#define DECLARE_HOOK(hooktype, routine, priority) \
|
|
const struct hook_data __hook_##hooktype##_##routine \
|
|
__attribute__((section(".rodata." #hooktype))) \
|
|
= {routine, priority}
|
|
|
|
#endif /* __CROS_EC_HOOKS_H */
|