Files
sunnypilot-byd/opendbc_repo/opendbc/safety/sunnypilot/mads_declarations.h
T
github-actions[bot] de77c89cf6 sunnypilot v2026.002.000
version: sunnypilot v2026.002.000 (staging)
date: 2026-07-21T07:44:02
master commit: 2c334ede443d7391d27575af8c854a095ba702a8
2026-07-21 07:44:02 +00:00

117 lines
4.1 KiB
C

/**
* Copyright (c) 2021-, Haibin Wen, sunnypilot, and a number of other contributors.
*
* This file is part of sunnypilot and is licensed under the MIT License.
* See the LICENSE.md file in the root directory for more details.
*/
#pragma once
// ===============================
// Type Definitions and Enums
// ===============================
typedef enum __attribute__((packed)) {
MADS_BUTTON_UNAVAILABLE = -1, ///< Button state cannot be determined
MADS_BUTTON_NOT_PRESSED = 0, ///< Button is not pressed
MADS_BUTTON_PRESSED = 1 ///< Button is pressed
} ButtonState;
typedef enum __attribute__((packed)) {
MADS_EDGE_NO_CHANGE = 0, ///< No state change detected
MADS_EDGE_RISING = 1, ///< State changed from false to true
MADS_EDGE_FALLING = 2 ///< State changed from true to false
} EdgeTransition;
typedef enum __attribute__((packed)) {
MADS_DISENGAGE_REASON_NONE = 0, ///< No disengagement
MADS_DISENGAGE_REASON_BRAKE = 1, ///< Brake pedal pressed
MADS_DISENGAGE_REASON_LAG = 2, ///< System lag detected
MADS_DISENGAGE_REASON_BUTTON = 4, ///< User button press
MADS_DISENGAGE_REASON_ACC_MAIN_OFF = 8, ///< ACC system turned off
MADS_DISENGAGE_REASON_NON_PCM_ACC_MAIN_DESYNC = 16, ///< ACC sync error
MADS_DISENGAGE_REASON_HEARTBEAT_ENGAGED_MISMATCH = 32, ///< Heartbeat mismatch
MADS_DISENGAGE_REASON_STEERING_DISENGAGE = 64, ///< Steering disengage
} DisengageReason;
// ===============================
// Constants and Defines
// ===============================
#define ALT_EXP_ENABLE_MADS 1024
#define ALT_EXP_MADS_DISENGAGE_LATERAL_ON_BRAKE 2048
#define ALT_EXP_MADS_PAUSE_LATERAL_ON_BRAKE 4096
#define MISMATCH_DEFAULT_THRESHOLD 25
// ===============================
// Data Structures
// ===============================
typedef struct {
DisengageReason active_reason; // The reason that actually disengaged controls
DisengageReason pending_reasons; // All conditions that would've prevented engagement while controls were disengaged
} DisengageState;
typedef struct {
ButtonState current;
ButtonState last;
EdgeTransition transition;
} ButtonStateTracking;
typedef struct {
EdgeTransition transition;
bool current : 1;
bool previous : 1;
} BinaryStateTracking;
typedef struct {
bool is_vehicle_moving : 1;
ButtonStateTracking mads_button;
BinaryStateTracking acc_main;
BinaryStateTracking op_controls_allowed;
BinaryStateTracking braking;
BinaryStateTracking mads_steering_disengage;
DisengageState current_disengage;
bool system_enabled : 1;
bool disengage_lateral_on_brake : 1;
bool pause_lateral_on_brake : 1;
bool controls_requested_lateral : 1;
} MADSState;
// ===============================
// Global Variables
// ===============================
extern ButtonState mads_button_press;
extern MADSState m_mads_state;
extern bool controls_allowed_lateral;
// state for mads controls_allowed_lateral timeout logic
extern bool heartbeat_engaged_mads;
extern uint32_t heartbeat_engaged_mads_mismatches;
// ===============================
// External Function Declarations (kept as needed)
// ===============================
extern void mads_set_system_state(bool enabled, bool disengage_lateral_on_brake, bool pause_lateral_on_brake);
extern void mads_set_alternative_experience(const int *mode);
extern void mads_state_update(bool op_vehicle_moving, bool op_acc_main, bool op_allowed, bool is_braking, bool steering_disengage);
extern void mads_exit_controls(DisengageReason reason);
extern void mads_heartbeat_engaged_check(void);
// ===============================
// Inline Function Implementations, must be included in the header file to comply with MISRA-C:2012 Rule 8.10
// These are really only used internally.
// ===============================
extern EdgeTransition m_get_edge_transition(bool current, bool last);
extern void m_mads_state_init(void);
extern void m_update_button_state(ButtonStateTracking *button_state);
extern void m_update_binary_state(BinaryStateTracking *state);
extern void m_update_control_state(void);