/* SPDX-License-Identifier: GPL-2.0-only */
/*
 *      include/asm-parisc/pdc_chassis.h
 *
 *      Copyright (C) 2002 Laurent Canet <canetl@esiee.fr>
 *      Copyright (C) 2002 Thibaut Varene <varenet@parisc-linux.org>
 *
 *      TODO:   - handle processor number on SMP systems (Reporting Entity ID)
 *              - handle message ID
 *              - handle timestamps
 */
 

#ifndef _PARISC_PDC_CHASSIS_H
#define _PARISC_PDC_CHASSIS_H

/*
 * ----------
 * Prototypes
 * ----------
 */

int pdc_chassis_send_status(int message);
void parisc_pdc_chassis_init(void);


/*
 * -----------------
 * Direct call names
 * -----------------
 * They setup everything for you, the Log message and the corresponding LED state
 */

#define PDC_CHASSIS_DIRECT_BSTART       0
#define PDC_CHASSIS_DIRECT_BCOMPLETE    1
#define PDC_CHASSIS_DIRECT_SHUTDOWN     2
#define PDC_CHASSIS_DIRECT_PANIC        3
#define PDC_CHASSIS_DIRECT_HPMC         4
#define PDC_CHASSIS_DIRECT_LPMC         5
#define PDC_CHASSIS_DIRECT_DUMP         6       /* not yet implemented */
#define PDC_CHASSIS_DIRECT_OOPS         7       /* not yet implemented */


/*
 * ------------
 * LEDs control
 * ------------
 * Set the three LEDs -- Run, Attn, and Fault.
 */

/* Old PDC LED control */
#define PDC_CHASSIS_DISP_DATA(v)        ((unsigned long)(v) << 17)

/* 
 * Available PDC PAT LED states
 */

#define PDC_CHASSIS_LED_RUN_OFF         (0ULL << 4)
#define PDC_CHASSIS_LED_RUN_FLASH       (1ULL << 4)
#define PDC_CHASSIS_LED_RUN_ON          (2ULL << 4)
#define PDC_CHASSIS_LED_RUN_NC          (3ULL << 4)
#define PDC_CHASSIS_LED_ATTN_OFF        (0ULL << 6)
#define PDC_CHASSIS_LED_ATTN_FLASH      (1ULL << 6)
#define PDC_CHASSIS_LED_ATTN_NC         (3ULL << 6)     /* ATTN ON is invalid */
#define PDC_CHASSIS_LED_FAULT_OFF       (0ULL << 8)
#define PDC_CHASSIS_LED_FAULT_FLASH     (1ULL << 8)
#define PDC_CHASSIS_LED_FAULT_ON        (2ULL << 8)
#define PDC_CHASSIS_LED_FAULT_NC        (3ULL << 8)
#define PDC_CHASSIS_LED_VALID           (1ULL << 10)

/* 
 * Valid PDC PAT LED states combinations
 */

/* System running normally */
#define PDC_CHASSIS_LSTATE_RUN_NORMAL   (PDC_CHASSIS_LED_RUN_ON         | \
                                         PDC_CHASSIS_LED_ATTN_OFF       | \
                                         PDC_CHASSIS_LED_FAULT_OFF      | \
                                         PDC_CHASSIS_LED_VALID          )
/* System crashed and rebooted itself successfully */
#define PDC_CHASSIS_LSTATE_RUN_CRASHREC (PDC_CHASSIS_LED_RUN_ON         | \
                                         PDC_CHASSIS_LED_ATTN_OFF       | \
                                         PDC_CHASSIS_LED_FAULT_FLASH    | \
                                         PDC_CHASSIS_LED_VALID          )
/* There was a system interruption that did not take the system down */
#define PDC_CHASSIS_LSTATE_RUN_SYSINT   (PDC_CHASSIS_LED_RUN_ON         | \
                                         PDC_CHASSIS_LED_ATTN_FLASH     | \
                                         PDC_CHASSIS_LED_FAULT_OFF      | \
                                         PDC_CHASSIS_LED_VALID          )
/* System running and unexpected reboot or non-critical error detected */
#define PDC_CHASSIS_LSTATE_RUN_NCRIT    (PDC_CHASSIS_LED_RUN_ON         | \
                                         PDC_CHASSIS_LED_ATTN_FLASH     | \
                                         PDC_CHASSIS_LED_FAULT_FLASH    | \
                                         PDC_CHASSIS_LED_VALID          )
/* Executing non-OS code */
#define PDC_CHASSIS_LSTATE_NONOS        (PDC_CHASSIS_LED_RUN_FLASH      | \
                                         PDC_CHASSIS_LED_ATTN_OFF       | \
                                         PDC_CHASSIS_LED_FAULT_OFF      | \
                                         PDC_CHASSIS_LED_VALID          )
/* Boot failed - Executing non-OS code */
#define PDC_CHASSIS_LSTATE_NONOS_BFAIL  (PDC_CHASSIS_LED_RUN_FLASH      | \
                                         PDC_CHASSIS_LED_ATTN_OFF       | \
                                         PDC_CHASSIS_LED_FAULT_ON       | \
                                         PDC_CHASSIS_LED_VALID          )
/* Unexpected reboot occurred - Executing non-OS code */
#define PDC_CHASSIS_LSTATE_NONOS_UNEXP  (PDC_CHASSIS_LED_RUN_FLASH      | \
                                         PDC_CHASSIS_LED_ATTN_OFF       | \
                                         PDC_CHASSIS_LED_FAULT_FLASH    | \
                                         PDC_CHASSIS_LED_VALID          )
/* Executing non-OS code - Non-critical error detected */
#define PDC_CHASSIS_LSTATE_NONOS_NCRIT  (PDC_CHASSIS_LED_RUN_FLASH      | \
                                         PDC_CHASSIS_LED_ATTN_FLASH     | \
                                         PDC_CHASSIS_LED_FAULT_OFF      | \
                                         PDC_CHASSIS_LED_VALID          )
/* Boot failed - Executing non-OS code - Non-critical error detected */
#define PDC_CHASSIS_LSTATE_BFAIL_NCRIT  (PDC_CHASSIS_LED_RUN_FLASH      | \
                                         PDC_CHASSIS_LED_ATTN_FLASH     | \
                                         PDC_CHASSIS_LED_FAULT_ON       | \
                                         PDC_CHASSIS_LED_VALID          )
/* Unexpected reboot/recovering - Executing non-OS code - Non-critical error detected */
#define PDC_CHASSIS_LSTATE_UNEXP_NCRIT  (PDC_CHASSIS_LED_RUN_FLASH      | \
                                         PDC_CHASSIS_LED_ATTN_FLASH     | \
                                         PDC_CHASSIS_LED_FAULT_FLASH    | \
                                         PDC_CHASSIS_LED_VALID          )
/* Cannot execute PDC */
#define PDC_CHASSIS_LSTATE_CANNOT_PDC   (PDC_CHASSIS_LED_RUN_OFF        | \
                                         PDC_CHASSIS_LED_ATTN_OFF       | \
                                         PDC_CHASSIS_LED_FAULT_OFF      | \
                                         PDC_CHASSIS_LED_VALID          )
/* Boot failed - OS not up - PDC has detected a failure that prevents boot */
#define PDC_CHASSIS_LSTATE_FATAL_BFAIL  (PDC_CHASSIS_LED_RUN_OFF        | \
                                         PDC_CHASSIS_LED_ATTN_OFF       | \
                                         PDC_CHASSIS_LED_FAULT_ON       | \
                                         PDC_CHASSIS_LED_VALID          )
/* No code running - Non-critical error detected (double fault situation) */
#define PDC_CHASSIS_LSTATE_NOCODE_NCRIT (PDC_CHASSIS_LED_RUN_OFF        | \
                                         PDC_CHASSIS_LED_ATTN_FLASH     | \
                                         PDC_CHASSIS_LED_FAULT_OFF      | \
                                         PDC_CHASSIS_LED_VALID          )
/* Boot failed - OS not up - Fatal failure detected - Non-critical error detected */
#define PDC_CHASSIS_LSTATE_FATAL_NCRIT  (PDC_CHASSIS_LED_RUN_OFF        | \
                                         PDC_CHASSIS_LED_ATTN_FLASH     | \
                                         PDC_CHASSIS_LED_FAULT_ON       | \
                                         PDC_CHASSIS_LED_VALID          )
/* All other states are invalid */


/*
 * --------------
 * PDC Log events
 * --------------
 * Here follows bits needed to fill up the log event sent to PDC_CHASSIS
 * The log message contains: Alert level, Source, Source detail,
 * Source ID, Problem detail, Caller activity, Activity status, 
 * Caller subactivity, Reporting entity type, Reporting entity ID,
 * Data type, Unique message ID and EOM. 
 */

/* Alert level */
#define PDC_CHASSIS_ALERT_FORWARD       (0ULL << 36)    /* no failure detected */
#define PDC_CHASSIS_ALERT_SERPROC       (1ULL << 36)    /* service proc - no failure */
#define PDC_CHASSIS_ALERT_NURGENT       (2ULL << 36)    /* non-urgent operator attn */
#define PDC_CHASSIS_ALERT_BLOCKED       (3ULL << 36)    /* system blocked */
#define PDC_CHASSIS_ALERT_CONF_CHG      (4ULL << 36)    /* unexpected configuration change */
#define PDC_CHASSIS_ALERT_ENV_PB        (5ULL << 36)    /* boot possible, environmental pb */
#define PDC_CHASSIS_ALERT_PENDING       (6ULL << 36)    /* boot possible, pending failure */
#define PDC_CHASSIS_ALERT_PERF_IMP      (8ULL << 36)    /* boot possible, performance impaired */
#define PDC_CHASSIS_ALERT_FUNC_IMP      (10ULL << 36)   /* boot possible, functionality impaired */
#define PDC_CHASSIS_ALERT_SOFT_FAIL     (12ULL << 36)   /* software failure */
#define PDC_CHASSIS_ALERT_HANG          (13ULL << 36)   /* system hang */
#define PDC_CHASSIS_ALERT_ENV_FATAL     (14ULL << 36)   /* fatal power or environmental pb */
#define PDC_CHASSIS_ALERT_HW_FATAL      (15ULL << 36)   /* fatal hardware problem */

/* Source */
#define PDC_CHASSIS_SRC_NONE            (0ULL << 28)    /* unknown, no source stated */
#define PDC_CHASSIS_SRC_PROC            (1ULL << 28)    /* processor */
/* For later use ? */
#define PDC_CHASSIS_SRC_PROC_CACHE      (2ULL << 28)    /* processor cache*/
#define PDC_CHASSIS_SRC_PDH             (3ULL << 28)    /* processor dependent hardware */
#define PDC_CHASSIS_SRC_PWR             (4ULL << 28)    /* power */
#define PDC_CHASSIS_SRC_FAB             (5ULL << 28)    /* fabric connector */
#define PDC_CHASSIS_SRC_PLATi           (6ULL << 28)    /* platform */
#define PDC_CHASSIS_SRC_MEM             (7ULL << 28)    /* memory */
#define PDC_CHASSIS_SRC_IO              (8ULL << 28)    /* I/O */
#define PDC_CHASSIS_SRC_CELL            (9ULL << 28)    /* cell */
#define PDC_CHASSIS_SRC_PD              (10ULL << 28)   /* protected domain */

/* Source detail field */
#define PDC_CHASSIS_SRC_D_PROC          (1ULL << 24)    /* processor general */

/* Source ID - platform dependent */
#define PDC_CHASSIS_SRC_ID_UNSPEC       (0ULL << 16)

/* Problem detail - problem source dependent */
#define PDC_CHASSIS_PB_D_PROC_NONE      (0ULL << 32)    /* no problem detail */
#define PDC_CHASSIS_PB_D_PROC_TIMEOUT   (4ULL << 32)    /* timeout */

/* Caller activity */
#define PDC_CHASSIS_CALL_ACT_HPUX_BL    (7ULL << 12)    /* Boot Loader */
#define PDC_CHASSIS_CALL_ACT_HPUX_PD    (8ULL << 12)    /* SAL_PD activities */
#define PDC_CHASSIS_CALL_ACT_HPUX_EVENT (9ULL << 12)    /* SAL_EVENTS activities */
#define PDC_CHASSIS_CALL_ACT_HPUX_IO    (10ULL << 12)   /* SAL_IO activities */
#define PDC_CHASSIS_CALL_ACT_HPUX_PANIC (11ULL << 12)   /* System panic */
#define PDC_CHASSIS_CALL_ACT_HPUX_INIT  (12ULL << 12)   /* System initialization */
#define PDC_CHASSIS_CALL_ACT_HPUX_SHUT  (13ULL << 12)   /* System shutdown */
#define PDC_CHASSIS_CALL_ACT_HPUX_WARN  (14ULL << 12)   /* System warning */
#define PDC_CHASSIS_CALL_ACT_HPUX_DU    (15ULL << 12)   /* Display_Activity() update */

/* Activity status - implementation dependent */
#define PDC_CHASSIS_ACT_STATUS_UNSPEC   (0ULL << 0)

/* Caller subactivity - implementation dependent */
/* FIXME: other subactivities ? */
#define PDC_CHASSIS_CALL_SACT_UNSPEC    (0ULL << 4)     /* implementation dependent */

/* Reporting entity type */
#define PDC_CHASSIS_RET_GENERICOS       (12ULL << 52)   /* generic OSes */
#define PDC_CHASSIS_RET_IA64_NT         (13ULL << 52)   /* IA-64 NT */
#define PDC_CHASSIS_RET_HPUX            (14ULL << 52)   /* HP-UX */
#define PDC_CHASSIS_RET_DIAG            (15ULL << 52)   /* offline diagnostics & utilities */

/* Reporting entity ID */
#define PDC_CHASSIS_REID_UNSPEC         (0ULL << 44)

/* Data type */
#define PDC_CHASSIS_DT_NONE             (0ULL << 59)    /* data field unused */
/* For later use ? Do we need these ? */
#define PDC_CHASSIS_DT_PHYS_ADDR        (1ULL << 59)    /* physical address */
#define PDC_CHASSIS_DT_DATA_EXPECT      (2ULL << 59)    /* expected data */
#define PDC_CHASSIS_DT_ACTUAL           (3ULL << 59)    /* actual data */
#define PDC_CHASSIS_DT_PHYS_LOC         (4ULL << 59)    /* physical location */
#define PDC_CHASSIS_DT_PHYS_LOC_EXT     (5ULL << 59)    /* physical location extension */
#define PDC_CHASSIS_DT_TAG              (6ULL << 59)    /* tag */
#define PDC_CHASSIS_DT_SYNDROME         (7ULL << 59)    /* syndrome */
#define PDC_CHASSIS_DT_CODE_ADDR        (8ULL << 59)    /* code address */
#define PDC_CHASSIS_DT_ASCII_MSG        (9ULL << 59)    /* ascii message */
#define PDC_CHASSIS_DT_POST             (10ULL << 59)   /* POST code */
#define PDC_CHASSIS_DT_TIMESTAMP        (11ULL << 59)   /* timestamp */
#define PDC_CHASSIS_DT_DEV_STAT         (12ULL << 59)   /* device status */
#define PDC_CHASSIS_DT_DEV_TYPE         (13ULL << 59)   /* device type */
#define PDC_CHASSIS_DT_PB_DET           (14ULL << 59)   /* problem detail */
#define PDC_CHASSIS_DT_ACT_LEV          (15ULL << 59)   /* activity level/timeout */
#define PDC_CHASSIS_DT_SER_NUM          (16ULL << 59)   /* serial number */
#define PDC_CHASSIS_DT_REV_NUM          (17ULL << 59)   /* revision number */
#define PDC_CHASSIS_DT_INTERRUPT        (18ULL << 59)   /* interruption information */
#define PDC_CHASSIS_DT_TEST_NUM         (19ULL << 59)   /* test number */
#define PDC_CHASSIS_DT_STATE_CHG        (20ULL << 59)   /* major changes in system state */
#define PDC_CHASSIS_DT_PROC_DEALLOC     (21ULL << 59)   /* processor deallocate */
#define PDC_CHASSIS_DT_RESET            (30ULL << 59)   /* reset type and cause */
#define PDC_CHASSIS_DT_PA_LEGACY        (31ULL << 59)   /* legacy PA hex chassis code */

/* System states - part of major changes in system state data field */
#define PDC_CHASSIS_SYSTATE_BSTART      (0ULL << 0)     /* boot start */
#define PDC_CHASSIS_SYSTATE_BCOMP       (1ULL << 0)     /* boot complete */
#define PDC_CHASSIS_SYSTATE_CHANGE      (2ULL << 0)     /* major change */
#define PDC_CHASSIS_SYSTATE_LED         (3ULL << 0)     /* LED change */
#define PDC_CHASSIS_SYSTATE_PANIC       (9ULL << 0)     /* OS Panic */
#define PDC_CHASSIS_SYSTATE_DUMP        (10ULL << 0)    /* memory dump */
#define PDC_CHASSIS_SYSTATE_HPMC        (11ULL << 0)    /* processing HPMC */
#define PDC_CHASSIS_SYSTATE_HALT        (15ULL << 0)    /* system halted */

/* Message ID */
#define PDC_CHASSIS_MSG_ID              (0ULL << 40)    /* we do not handle msg IDs atm */

/* EOM - separates log entries */
#define PDC_CHASSIS_EOM_CLEAR           (0ULL << 43)
#define PDC_CHASSIS_EOM_SET             (1ULL << 43)

/*
 * Preformated well known messages
 */

/* Boot started */
#define PDC_CHASSIS_PMSG_BSTART         (PDC_CHASSIS_ALERT_SERPROC      | \
                                         PDC_CHASSIS_SRC_PROC           | \
                                         PDC_CHASSIS_SRC_D_PROC         | \
                                         PDC_CHASSIS_SRC_ID_UNSPEC      | \
                                         PDC_CHASSIS_PB_D_PROC_NONE     | \
                                         PDC_CHASSIS_CALL_ACT_HPUX_INIT | \
                                         PDC_CHASSIS_ACT_STATUS_UNSPEC  | \
                                         PDC_CHASSIS_CALL_SACT_UNSPEC   | \
                                         PDC_CHASSIS_RET_HPUX           | \
                                         PDC_CHASSIS_REID_UNSPEC        | \
                                         PDC_CHASSIS_DT_STATE_CHG       | \
                                         PDC_CHASSIS_SYSTATE_BSTART     | \
                                         PDC_CHASSIS_MSG_ID             | \
                                         PDC_CHASSIS_EOM_SET            )

/* Boot complete */
#define PDC_CHASSIS_PMSG_BCOMPLETE      (PDC_CHASSIS_ALERT_SERPROC      | \
                                         PDC_CHASSIS_SRC_PROC           | \
                                         PDC_CHASSIS_SRC_D_PROC         | \
                                         PDC_CHASSIS_SRC_ID_UNSPEC      | \
                                         PDC_CHASSIS_PB_D_PROC_NONE     | \
                                         PDC_CHASSIS_CALL_ACT_HPUX_INIT | \
                                         PDC_CHASSIS_ACT_STATUS_UNSPEC  | \
                                         PDC_CHASSIS_CALL_SACT_UNSPEC   | \
                                         PDC_CHASSIS_RET_HPUX           | \
                                         PDC_CHASSIS_REID_UNSPEC        | \
                                         PDC_CHASSIS_DT_STATE_CHG       | \
                                         PDC_CHASSIS_SYSTATE_BCOMP      | \
                                         PDC_CHASSIS_MSG_ID             | \
                                         PDC_CHASSIS_EOM_SET            )

/* Shutdown */
#define PDC_CHASSIS_PMSG_SHUTDOWN       (PDC_CHASSIS_ALERT_SERPROC      | \
                                         PDC_CHASSIS_SRC_PROC           | \
                                         PDC_CHASSIS_SRC_D_PROC         | \
                                         PDC_CHASSIS_SRC_ID_UNSPEC      | \
                                         PDC_CHASSIS_PB_D_PROC_NONE     | \
                                         PDC_CHASSIS_CALL_ACT_HPUX_SHUT | \
                                         PDC_CHASSIS_ACT_STATUS_UNSPEC  | \
                                         PDC_CHASSIS_CALL_SACT_UNSPEC   | \
                                         PDC_CHASSIS_RET_HPUX           | \
                                         PDC_CHASSIS_REID_UNSPEC        | \
                                         PDC_CHASSIS_DT_STATE_CHG       | \
                                         PDC_CHASSIS_SYSTATE_HALT       | \
                                         PDC_CHASSIS_MSG_ID             | \
                                         PDC_CHASSIS_EOM_SET            )

/* Panic */
#define PDC_CHASSIS_PMSG_PANIC          (PDC_CHASSIS_ALERT_SOFT_FAIL    | \
                                         PDC_CHASSIS_SRC_PROC           | \
                                         PDC_CHASSIS_SRC_D_PROC         | \
                                         PDC_CHASSIS_SRC_ID_UNSPEC      | \
                                         PDC_CHASSIS_PB_D_PROC_NONE     | \
                                         PDC_CHASSIS_CALL_ACT_HPUX_PANIC| \
                                         PDC_CHASSIS_ACT_STATUS_UNSPEC  | \
                                         PDC_CHASSIS_CALL_SACT_UNSPEC   | \
                                         PDC_CHASSIS_RET_HPUX           | \
                                         PDC_CHASSIS_REID_UNSPEC        | \
                                         PDC_CHASSIS_DT_STATE_CHG       | \
                                         PDC_CHASSIS_SYSTATE_PANIC      | \
                                         PDC_CHASSIS_MSG_ID             | \
                                         PDC_CHASSIS_EOM_SET            )

// FIXME: extrapolated data
/* HPMC */
#define PDC_CHASSIS_PMSG_HPMC           (PDC_CHASSIS_ALERT_CONF_CHG /*?*/       | \
                                         PDC_CHASSIS_SRC_PROC           | \
                                         PDC_CHASSIS_SRC_D_PROC         | \
                                         PDC_CHASSIS_SRC_ID_UNSPEC      | \
                                         PDC_CHASSIS_PB_D_PROC_NONE     | \
                                         PDC_CHASSIS_CALL_ACT_HPUX_WARN | \
                                         PDC_CHASSIS_RET_HPUX           | \
                                         PDC_CHASSIS_DT_STATE_CHG       | \
                                         PDC_CHASSIS_SYSTATE_HPMC       | \
                                         PDC_CHASSIS_MSG_ID             | \
                                         PDC_CHASSIS_EOM_SET            )

/* LPMC */
#define PDC_CHASSIS_PMSG_LPMC           (PDC_CHASSIS_ALERT_BLOCKED /*?*/| \
                                         PDC_CHASSIS_SRC_PROC           | \
                                         PDC_CHASSIS_SRC_D_PROC         | \
                                         PDC_CHASSIS_SRC_ID_UNSPEC      | \
                                         PDC_CHASSIS_PB_D_PROC_NONE     | \
                                         PDC_CHASSIS_CALL_ACT_HPUX_WARN | \
                                         PDC_CHASSIS_ACT_STATUS_UNSPEC  | \
                                         PDC_CHASSIS_CALL_SACT_UNSPEC   | \
                                         PDC_CHASSIS_RET_HPUX           | \
                                         PDC_CHASSIS_REID_UNSPEC        | \
                                         PDC_CHASSIS_DT_STATE_CHG       | \
                                         PDC_CHASSIS_SYSTATE_CHANGE     | \
                                         PDC_CHASSIS_MSG_ID             | \
                                         PDC_CHASSIS_EOM_SET            )

#endif /* _PARISC_PDC_CHASSIS_H */