coreboot
coreboot is an Open Source project aimed at replacing the proprietary BIOS found in most computers.
state_machine.h
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 
3 #ifndef _STATE_MACHINE_H_
4 #define _STATE_MACHINE_H_
5 
6 #include <stdint.h>
7 #include <AGESA.h>
8 #include <AMD.h>
9 
10 /* eventlog */
11 void agesawrapper_trace(AGESA_STATUS ret, AMD_CONFIG_PARAMS *StdHeader, const char *func);
13 
14 /* For suspend-to-ram support. */
15 
16 #if !CONFIG(CPU_AMD_PI)
17 /* TODO: With binaryPI we need different interface. */
18 AGESA_STATUS OemInitResume(AMD_S3_PARAMS *dataBlock);
19 AGESA_STATUS OemS3LateRestore(AMD_S3_PARAMS *dataBlock);
20 AGESA_STATUS OemS3Save(AMD_S3_PARAMS *dataBlock);
21 #endif
22 
23 /* For FCH */
26 
27 struct sysinfo
28 {
30 
31  int s3resume;
32 };
33 
34 void board_BeforeAgesa(struct sysinfo *cb);
35 
36 void agesa_set_interface(struct sysinfo *cb);
37 
38 struct agesa_state {
40 
41  AGESA_STRUCT_NAME func;
42  const char *function_name;
45 };
46 
47 void agesa_state_on_entry(struct agesa_state *task, AGESA_STRUCT_NAME func);
48 void agesa_state_on_exit(struct agesa_state *task,
49  AMD_CONFIG_PARAMS *StdHeader);
50 int agesa_execute_state(struct sysinfo *cb, AGESA_STRUCT_NAME func);
51 
52 /* AGESA dispatchers */
53 
54 AGESA_STATUS module_dispatch(AGESA_STRUCT_NAME func, AMD_CONFIG_PARAMS *StdHeader);
55 
56 void platform_BeforeInitReset(struct sysinfo *cb, AMD_RESET_PARAMS *Reset);
57 void board_BeforeInitReset(struct sysinfo *cb, AMD_RESET_PARAMS *Reset);
58 
59 void platform_BeforeInitEarly(struct sysinfo *cb, AMD_EARLY_PARAMS *Early);
60 void board_BeforeInitEarly(struct sysinfo *cb, AMD_EARLY_PARAMS *Early);
61 
62 /* Normal boot */
63 void platform_BeforeInitPost(struct sysinfo *cb, AMD_POST_PARAMS *Post);
64 void board_BeforeInitPost(struct sysinfo *cb, AMD_POST_PARAMS *Post);
65 void platform_AfterInitPost(struct sysinfo *cb, AMD_POST_PARAMS *Post);
66 
67 void platform_BeforeInitEnv(struct sysinfo *cb, AMD_ENV_PARAMS *Env);
68 void board_BeforeInitEnv(struct sysinfo *cb, AMD_ENV_PARAMS *Env);
69 void platform_AfterInitEnv(struct sysinfo *cb, AMD_ENV_PARAMS *Env);
70 
71 void platform_BeforeInitMid(struct sysinfo *cb, AMD_MID_PARAMS *Mid);
72 void board_BeforeInitMid(struct sysinfo *cb, AMD_MID_PARAMS *Mid);
73 
74 void platform_BeforeInitLate(struct sysinfo *cb, AMD_LATE_PARAMS *Late);
75 void board_BeforeInitLate(struct sysinfo *cb, AMD_LATE_PARAMS *Late);
76 void platform_AfterInitLate(struct sysinfo *cb, AMD_LATE_PARAMS *Late);
77 void completion_InitLate(struct sysinfo *cb, AMD_LATE_PARAMS *Late);
78 
79 /* S3 Resume */
80 void platform_BeforeInitResume(struct sysinfo *cb, AMD_RESUME_PARAMS *Resume);
81 void platform_AfterInitResume(struct sysinfo *cb, AMD_RESUME_PARAMS *Resume);
82 
83 void platform_BeforeS3LateRestore(struct sysinfo *cb, AMD_S3LATE_PARAMS *S3Late);
84 void platform_AfterS3LateRestore(struct sysinfo *cb, AMD_S3LATE_PARAMS *S3Late);
85 
86 void platform_AfterS3Save(struct sysinfo *cb, AMD_S3SAVE_PARAMS *S3Save);
87 
88 /* FCH callouts, not used with CIMx. */
89 #define HAS_AGESA_FCH_OEM_CALLOUT \
90  CONFIG(SOUTHBRIDGE_AMD_AGESA_HUDSON) || \
91  CONFIG(SOUTHBRIDGE_AMD_AGESA_YANGTZE) || \
92  CONFIG(SOUTHBRIDGE_AMD_PI_AVALON) || \
93  CONFIG(SOUTHBRIDGE_AMD_PI_KERN)
94 
95 #if HAS_AGESA_FCH_OEM_CALLOUT
96 /* FIXME: Structures included here were supposed to be private to AGESA. */
97 #include <FchCommonCfg.h>
98 void agesa_fch_oem_config(uintptr_t Data, AMD_CONFIG_PARAMS *StdHeader);
99 void board_FCH_InitReset(struct sysinfo *cb, FCH_RESET_DATA_BLOCK *FchReset);
100 void board_FCH_InitEnv(struct sysinfo *cb, FCH_DATA_BLOCK *FchEnv);
101 #endif
102 
103 #endif /* _STATE_MACHINE_H_ */
unsigned int AGESA_STATUS
Definition: Amd.h:36
void board_FCH_InitReset(struct sysinfo *cb_NA, FCH_RESET_DATA_BLOCK *FchParams_reset)
Definition: BiosCallOuts.c:157
void board_FCH_InitEnv(struct sysinfo *cb_NA, FCH_DATA_BLOCK *FchParams_env)
Definition: BiosCallOuts.c:161
void platform_BeforeInitReset(struct sysinfo *cb, AMD_RESET_PARAMS *Reset)
Definition: state_machine.c:17
void board_BeforeInitEnv(struct sysinfo *cb, AMD_ENV_PARAMS *Env)
void platform_AfterInitLate(struct sysinfo *cb, AMD_LATE_PARAMS *Late)
Definition: state_machine.c:99
void agesawrapper_trace(AGESA_STATUS ret, AMD_CONFIG_PARAMS *StdHeader, const char *func)
Definition: eventlog.c:182
void board_BeforeInitPost(struct sysinfo *cb, AMD_POST_PARAMS *Post)
void board_BeforeInitReset(struct sysinfo *cb, AMD_RESET_PARAMS *Reset)
AGESA_STATUS OemS3LateRestore(AMD_S3_PARAMS *dataBlock)
Definition: oem_s3.c:63
void board_BeforeInitLate(struct sysinfo *cb, AMD_LATE_PARAMS *Late)
void agesa_state_on_entry(struct agesa_state *task, AGESA_STRUCT_NAME func)
Definition: eventlog.c:97
void platform_BeforeS3LateRestore(struct sysinfo *cb, AMD_S3LATE_PARAMS *S3Late)
Definition: state_machine.c:78
void platform_BeforeInitMid(struct sysinfo *cb, AMD_MID_PARAMS *Mid)
Definition: state_machine.c:87
void platform_AfterS3LateRestore(struct sysinfo *cb, AMD_S3LATE_PARAMS *S3Late)
Definition: state_machine.c:83
AGESA_STATUS agesawrapper_amdreadeventlog(UINT8 HeapStatus)
Definition: eventlog.c:197
void board_BeforeAgesa(struct sysinfo *cb)
Definition: romstage.c:19
void completion_InitLate(struct sysinfo *cb, AMD_LATE_PARAMS *Late)
Definition: acpi_tables.c:29
void platform_BeforeInitEnv(struct sysinfo *cb, AMD_ENV_PARAMS *Env)
Definition: state_machine.c:68
AGESA_STATUS OemInitResume(AMD_S3_PARAMS *dataBlock)
Definition: oem_s3.c:47
void platform_BeforeInitLate(struct sysinfo *cb, AMD_LATE_PARAMS *Late)
Definition: state_machine.c:95
void platform_BeforeInitPost(struct sysinfo *cb, AMD_POST_PARAMS *Post)
Definition: state_machine.c:48
void platform_BeforeInitEarly(struct sysinfo *cb, AMD_EARLY_PARAMS *Early)
Definition: state_machine.c:44
void platform_AfterInitPost(struct sysinfo *cb, AMD_POST_PARAMS *Post)
Definition: state_machine.c:54
void agesa_set_interface(struct sysinfo *cb)
Definition: state_machine.c:43
AGESA_STATUS OemS3Save(AMD_S3_PARAMS *dataBlock)
void board_BeforeInitEarly(struct sysinfo *cb, AMD_EARLY_PARAMS *Early)
void platform_BeforeInitResume(struct sysinfo *cb, AMD_RESUME_PARAMS *Resume)
Definition: state_machine.c:59
void platform_AfterInitEnv(struct sysinfo *cb, AMD_ENV_PARAMS *Env)
Definition: state_machine.c:73
int agesa_execute_state(struct sysinfo *cb, AGESA_STRUCT_NAME func)
void platform_AfterInitResume(struct sysinfo *cb, AMD_RESUME_PARAMS *Resume)
Definition: state_machine.c:64
void board_BeforeInitMid(struct sysinfo *cb, AMD_MID_PARAMS *Mid)
void platform_AfterS3Save(struct sysinfo *cb, AMD_S3SAVE_PARAMS *S3Save)
void agesa_state_on_exit(struct agesa_state *task, AMD_CONFIG_PARAMS *StdHeader)
Definition: eventlog.c:118
AGESA_STATUS fchs3laterestore(AMD_CONFIG_PARAMS *StdHeader)
AGESA_STATUS module_dispatch(AGESA_STRUCT_NAME func, AMD_CONFIG_PARAMS *StdHeader)
Definition: state_machine.c:60
AGESA_STATUS fchs3earlyrestore(AMD_CONFIG_PARAMS *StdHeader)
unsigned int uint32_t
Definition: stdint.h:14
unsigned long uintptr_t
Definition: stdint.h:21
uint8_t u8
Definition: stdint.h:45
The standard header for all AGESA services.
Definition: Amd.h:74
uint32_t ts_entry_id
Definition: state_machine.h:43
uint32_t ts_exit_id
Definition: state_machine.h:44
AGESA_STRUCT_NAME func
Definition: state_machine.h:41
const char * function_name
Definition: state_machine.h:42
AMD_CONFIG_PARAMS StdHeader
Definition: state_machine.h:29
int s3resume
Definition: state_machine.h:31