94084e5aba
See Discussion https://github.com/zephyrproject-rtos/zephyr/discussions/83659 for information about the purpose of this change. Modifies run actions of hierarchical state machines to return a value indicating if the event was handled by the run action or should be propagated up to the parent run action. Flat state machines are not affected, and their run action returns void. smf_set_handled() has been removed and replaced by this return value. smf_set_state() will not propagate events regardless of the return value as the transition is considered to have occurred. Documentation, tests, samples, has been updated. USB-C and hawkBit use SMF and have been updated to use the new return codes. Signed-off-by: Glenn Andrews <glenn.andrews.42@gmail.com>
104 lines
2.6 KiB
C
104 lines
2.6 KiB
C
/*
|
|
* Copyright (c) 2023 The Chromium OS Authors
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef ZEPHYR_SUBSYS_USBC_PE_SRC_STATES_INTERNAL_H_
|
|
#define ZEPHYR_SUBSYS_USBC_PE_SRC_STATES_INTERNAL_H_
|
|
|
|
/**
|
|
* @brief Init the PE Source State machine
|
|
*/
|
|
void pe_src_init(const struct device *dev);
|
|
|
|
/**
|
|
* @brief Handle Source-specific DPM requests
|
|
*/
|
|
bool source_dpm_requests(const struct device *dev);
|
|
|
|
/**
|
|
* @brief PE_SRC_Startup State
|
|
*/
|
|
void pe_src_startup_entry(void *obj);
|
|
enum smf_state_result pe_src_startup_run(void *obj);
|
|
void pe_src_startup_exit(void *obj);
|
|
|
|
/**
|
|
* @brief PE_SRC_Discovery State
|
|
*/
|
|
void pe_src_discovery_entry(void *obj);
|
|
enum smf_state_result pe_src_discovery_run(void *obj);
|
|
void pe_src_discovery_exit(void *obj);
|
|
|
|
/**
|
|
* @brief PE_SRC_Send_Capabilities State
|
|
*/
|
|
void pe_src_send_capabilities_entry(void *obj);
|
|
enum smf_state_result pe_src_send_capabilities_run(void *obj);
|
|
void pe_src_send_capabilities_exit(void *obj);
|
|
|
|
/**
|
|
* @brief PE_SRC_Negotiate_Capability State
|
|
*/
|
|
void pe_src_negotiate_capability_entry(void *obj);
|
|
|
|
/**
|
|
* @brief PE_SRC_Transition_Supply State
|
|
*/
|
|
void pe_src_transition_supply_entry(void *obj);
|
|
enum smf_state_result pe_src_transition_supply_run(void *obj);
|
|
void pe_src_transition_supply_exit(void *obj);
|
|
|
|
/**
|
|
* @brief PE_SRC_Ready State
|
|
*/
|
|
void pe_src_ready_entry(void *obj);
|
|
enum smf_state_result pe_src_ready_run(void *obj);
|
|
void pe_src_ready_exit(void *obj);
|
|
|
|
/**
|
|
* @brief PE_SRC_Disabled State
|
|
*/
|
|
void pe_src_disabled_entry(void *obj);
|
|
|
|
/**
|
|
* @brief PE_SRC_Transition_To_Default State
|
|
*/
|
|
void pe_src_transition_to_default_entry(void *obj);
|
|
enum smf_state_result pe_src_transition_to_default_run(void *obj);
|
|
void pe_src_transition_to_default_exit(void *obj);
|
|
|
|
/**
|
|
* @brief PE_SRC_Hard_Reset State
|
|
*/
|
|
void pe_src_hard_reset_entry(void *obj);
|
|
enum smf_state_result pe_src_hard_reset_run(void *obj);
|
|
void pe_src_hard_reset_exit(void *obj);
|
|
|
|
/**
|
|
* @brief PE_SRC_Capability_Response State
|
|
*/
|
|
void pe_src_capability_response_entry(void *obj);
|
|
enum smf_state_result pe_src_capability_response_run(void *obj);
|
|
void pe_src_capability_response_exit(void *obj);
|
|
|
|
/**
|
|
* @brief PE_SRC_Wait_New_Capabilities State
|
|
*/
|
|
void pe_src_wait_new_capabilities_entry(void *obj);
|
|
enum smf_state_result pe_src_wait_new_capabilities_run(void *obj);
|
|
void pe_src_wait_new_capabilities_exit(void *obj);
|
|
|
|
/**
|
|
* @brief PE_SRC_Hard_Reset_Parent State
|
|
*
|
|
* Parent state of PE_SRC_Hard_Reset and
|
|
* PE_SRC_Hard_Reset_Received States
|
|
*/
|
|
void pe_src_hard_reset_parent_entry(void *obj);
|
|
enum smf_state_result pe_src_hard_reset_parent_run(void *obj);
|
|
void pe_src_hard_reset_parent_exit(void *obj);
|
|
|
|
#endif /* ZEPHYR_SUBSYS_USBC_PE_SRC_STATES_INTERNAL_H_ */
|