/*
 * Copyright (C) 2018 Intel Corporation. All rights reserved.
 *
 * SPDX-License-Identifier: BSD-3-Clause
 */

#ifndef INTR_LAPIC_H
#define INTR_LAPIC_H

/* intr_lapic_icr_delivery_mode */
#define INTR_LAPIC_ICR_FIXED    0x0U
#define INTR_LAPIC_ICR_LP          0x1U
#define INTR_LAPIC_ICR_SMI        0x2U
#define INTR_LAPIC_ICR_NMI       0x4U
#define INTR_LAPIC_ICR_INIT       0x5U
#define INTR_LAPIC_ICR_STARTUP  0x6U

/* intr_lapic_icr_dest_mode */
#define INTR_LAPIC_ICR_PHYSICAL 0x0U
#define INTR_LAPIC_ICR_LOGICAL  0x1U

/* intr_lapic_icr_level */
#define INTR_LAPIC_ICR_DEASSERT  0x0U
#define INTR_LAPIC_ICR_ASSERT       0x1U

/* intr_lapic_icr_trigger */
#define INTR_LAPIC_ICR_EDGE         0x0U
#define INTR_LAPIC_ICR_LEVEL        0x1U

/* intr_lapic_icr_shorthand */
#define INTR_LAPIC_ICR_USE_DEST_ARRAY    0x0U
#define INTR_LAPIC_ICR_SELF                          0x1U
#define INTR_LAPIC_ICR_ALL_INC_SELF         0x2U
#define INTR_LAPIC_ICR_ALL_EX_SELF            0x3U

/* LAPIC register offset for memory mapped IO access */
#define LAPIC_ID_REGISTER                       0x00000020U
#define LAPIC_VERSION_REGISTER                  0x00000030U
#define LAPIC_TASK_PRIORITY_REGISTER            0x00000080U
#define LAPIC_ARBITRATION_PRIORITY_REGISTER     0x00000090U
#define LAPIC_PROCESSOR_PRIORITY_REGISTER       0x000000A0U
#define LAPIC_EOI_REGISTER                      0x000000B0U
#define LAPIC_REMOTE_READ_REGISTER              0x000000C0U
#define LAPIC_LOGICAL_DESTINATION_REGISTER      0x000000D0U
#define LAPIC_DESTINATION_FORMAT_REGISTER       0x000000E0U
#define LAPIC_SPURIOUS_VECTOR_REGISTER          0x000000F0U
#define LAPIC_IN_SERVICE_REGISTER_0             0x00000100U
#define LAPIC_IN_SERVICE_REGISTER_1             0x00000110U
#define LAPIC_IN_SERVICE_REGISTER_2             0x00000120U
#define LAPIC_IN_SERVICE_REGISTER_3             0x00000130U
#define LAPIC_IN_SERVICE_REGISTER_4             0x00000140U
#define LAPIC_IN_SERVICE_REGISTER_5             0x00000150U
#define LAPIC_IN_SERVICE_REGISTER_6             0x00000160U
#define LAPIC_IN_SERVICE_REGISTER_7             0x00000170U
#define LAPIC_TRIGGER_MODE_REGISTER_0           0x00000180U
#define LAPIC_TRIGGER_MODE_REGISTER_1           0x00000190U
#define LAPIC_TRIGGER_MODE_REGISTER_2           0x000001A0U
#define LAPIC_TRIGGER_MODE_REGISTER_3           0x000001B0U
#define LAPIC_TRIGGER_MODE_REGISTER_4           0x000001C0U
#define LAPIC_TRIGGER_MODE_REGISTER_5           0x000001D0U
#define LAPIC_TRIGGER_MODE_REGISTER_6           0x000001E0U
#define LAPIC_TRIGGER_MODE_REGISTER_7           0x000001F0U
#define LAPIC_INT_REQUEST_REGISTER_0            0x00000200U
#define LAPIC_INT_REQUEST_REGISTER_1            0x00000210U
#define LAPIC_INT_REQUEST_REGISTER_2            0x00000220U
#define LAPIC_INT_REQUEST_REGISTER_3            0x00000230U
#define LAPIC_INT_REQUEST_REGISTER_4            0x00000240U
#define LAPIC_INT_REQUEST_REGISTER_5            0x00000250U
#define LAPIC_INT_REQUEST_REGISTER_6            0x00000260U
#define LAPIC_INT_REQUEST_REGISTER_7            0x00000270U
#define LAPIC_ERROR_STATUS_REGISTER             0x00000280U
#define LAPIC_LVT_CMCI_REGISTER                 0x000002F0U
#define LAPIC_INT_COMMAND_REGISTER_0            0x00000300U
#define LAPIC_INT_COMMAND_REGISTER_1            0x00000310U
#define LAPIC_LVT_TIMER_REGISTER                0x00000320U
#define LAPIC_LVT_THERMAL_SENSOR_REGISTER       0x00000330U
#define LAPIC_LVT_PMC_REGISTER                  0x00000340U
#define LAPIC_LVT_LINT0_REGISTER                0x00000350U
#define LAPIC_LVT_LINT1_REGISTER                0x00000360U
#define LAPIC_LVT_ERROR_REGISTER                0x00000370U
#define LAPIC_INITIAL_COUNT_REGISTER            0x00000380U
#define LAPIC_CURRENT_COUNT_REGISTER            0x00000390U
#define LAPIC_DIVIDE_CONFIGURATION_REGISTER     0x000003E0U

/* LAPIC CPUID bit and bitmask definitions */
#define CPUID_OUT_RDX_APIC_PRESENT              ((uint64_t) 1UL <<  9U)
#define CPUID_OUT_RCX_X2APIC_PRESENT            ((uint64_t) 1UL << 21U)

/* LAPIC MSR bit and bitmask definitions */
#define MSR_01B_XAPIC_GLOBAL_ENABLE             ((uint64_t) 1UL << 11U)

/* LAPIC register bit and bitmask definitions */
#define LAPIC_SVR_VECTOR                        0x000000FFU
#define LAPIC_SVR_APIC_ENABLE_MASK                   0x00000100U

#define LAPIC_LVT_MASK                          0x00010000U
#define LAPIC_DELIVERY_MODE_EXTINT_MASK         0x00000700U

/* LAPIC Timer bit and bitmask definitions */
#define LAPIC_TMR_ONESHOT                       ((uint32_t) 0x0U << 17U)
#define LAPIC_TMR_PERIODIC                      ((uint32_t) 0x1U << 17U)
#define LAPIC_TMR_TSC_DEADLINE                  ((uint32_t) 0x2U << 17U)

enum intr_cpu_startup_shorthand {
	INTR_CPU_STARTUP_USE_DEST,
	INTR_CPU_STARTUP_ALL_EX_SELF,
	INTR_CPU_STARTUP_UNKNOWN,
};

union lapic_id_reg {
	uint32_t value;
	struct {
		uint8_t xapic_id;
		uint8_t rsvd[3];
	} xapic;
	union {
		uint32_t value;
		struct {
			uint8_t xapic_id;
			uint8_t xapic_edid;
			uint8_t rsvd[2];
		} ioxapic_view;
		struct {
			uint32_t x2apic_id:4;
			uint32_t x2apic_cluster:28;
		} ldr_view;
	} x2apic;
};

void write_lapic_reg32(uint32_t offset, uint32_t value);
void save_lapic(struct lapic_regs *regs);
void early_init_lapic(void);
void init_lapic(uint16_t pcpu_id);
void send_lapic_eoi(void);
uint8_t get_cur_lapic_id(void);
void send_startup_ipi(enum intr_cpu_startup_shorthand cpu_startup_shorthand,
		uint16_t dest_pcpu_id,
		uint64_t cpu_startup_start_address);
/* API to send an IPI to dest guest */
void send_dest_ipi(uint32_t dest, uint32_t vector, uint32_t dest_mode);
/* API to send an IPI to a single guest */
void send_single_ipi(uint16_t pcpu_id, uint32_t vector);

void suspend_lapic(void);
void resume_lapic(void);

#endif /* INTR_LAPIC_H */