xref: /openbsd/usr.sbin/vmd/i8259.h (revision ba66f564)
1*ba66f564Sdv /* $OpenBSD: i8259.h,v 1.7 2024/07/09 09:31:37 dv Exp $ */
2ecc93de1Smlarkin /*
3ecc93de1Smlarkin  * Copyright (c) 2016 Mike Larkin <mlarkin@openbsd.org>
4ecc93de1Smlarkin  *
5ecc93de1Smlarkin  * Permission to use, copy, modify, and distribute this software for any
6ecc93de1Smlarkin  * purpose with or without fee is hereby granted, provided that the above
7ecc93de1Smlarkin  * copyright notice and this permission notice appear in all copies.
8ecc93de1Smlarkin  *
9ecc93de1Smlarkin  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10ecc93de1Smlarkin  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11ecc93de1Smlarkin  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12ecc93de1Smlarkin  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13ecc93de1Smlarkin  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14ecc93de1Smlarkin  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15ecc93de1Smlarkin  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16ecc93de1Smlarkin  */
17ecc93de1Smlarkin 
18ecc93de1Smlarkin #include <sys/types.h>
19ecc93de1Smlarkin 
20ecc93de1Smlarkin #define MASTER			0
21ecc93de1Smlarkin #define SLAVE			1
22ecc93de1Smlarkin 
2333de4f94Sdv #define ELCR0			0x4D0
2433de4f94Sdv #define ELCR1			0x4D1
2533de4f94Sdv 
26ecc93de1Smlarkin #define ICW1_ICW4		(0x1 << 0)
27ecc93de1Smlarkin #define ICW1_SNGL		(0x1 << 1)
28ecc93de1Smlarkin #define ICW1_ADI		(0x1 << 2)
29ecc93de1Smlarkin #define ICW1_LTIM		(0x1 << 3)
30ecc93de1Smlarkin #define ICW1_INIT		(0x1 << 4)
31ecc93de1Smlarkin #define ICW1_IVA1		(0x1 << 5)
32ecc93de1Smlarkin #define ICW1_IVA2		(0x1 << 6)
33ecc93de1Smlarkin #define ICW1_IVA3		(0x1 << 7)
34ecc93de1Smlarkin #define ICW4_UP			(0x1 << 0)
35ecc93de1Smlarkin #define ICW4_AEOI		(0x1 << 1)
36ecc93de1Smlarkin #define ICW4_MS			(0x1 << 2)
37ecc93de1Smlarkin #define ICW4_BUF		(0x1 << 3)
38ecc93de1Smlarkin #define ICW4_SNFM		(0x1 << 4)
39ecc93de1Smlarkin 
40ecc93de1Smlarkin #define OCW_SELECT		(0x1 << 3)
41ecc93de1Smlarkin 
42ecc93de1Smlarkin #define OCW2_ROTATE_AEOI_CLEAR	0x00
43ecc93de1Smlarkin #define OCW2_EOI		0x20
44ecc93de1Smlarkin #define OCW2_NOP		0x40
45ecc93de1Smlarkin #define OCW2_SEOI		0x60
46ecc93de1Smlarkin #define OCW2_ROTATE_AEOI_SET	0x80
47ecc93de1Smlarkin #define OCW2_ROTATE_NSEOI	0xA0
48ecc93de1Smlarkin #define OCW2_SET_LOWPRIO	0xC0
49ecc93de1Smlarkin #define OCW2_ROTATE_SEOI	0xE0
50ecc93de1Smlarkin #define OCW3_RIS		(0x1 << 0)
51ecc93de1Smlarkin #define OCW3_RR			(0x1 << 1)
52ecc93de1Smlarkin #define OCW3_POLL		(0x1 << 2)
53ecc93de1Smlarkin #define OCW3_ACTION		(0x1 << 3)
54ecc93de1Smlarkin #define OCW3_SMM		(0x1 << 5)
55ecc93de1Smlarkin #define OCW3_SMACTION		(0x1 << 6)
56ecc93de1Smlarkin 
57ecc93de1Smlarkin /* PIC functions called by device emulation code */
58ecc93de1Smlarkin void i8259_assert_irq(uint8_t);
59ecc93de1Smlarkin void i8259_deassert_irq(uint8_t);
60ecc93de1Smlarkin 
61ecc93de1Smlarkin /* PIC functions called by the in/out exit handler */
62ecc93de1Smlarkin uint8_t vcpu_exit_i8259(struct vm_run_params *);
63ecc93de1Smlarkin 
64ecc93de1Smlarkin void i8259_init(void);
65ecc93de1Smlarkin uint16_t i8259_ack(void);
66ecc93de1Smlarkin uint8_t i8259_is_pending(void);
67149417b6Sreyk int i8259_restore(int);
68149417b6Sreyk int i8259_dump(int);
69d326e819Smlarkin 
70d326e819Smlarkin /* ELCR functions */
71d326e819Smlarkin void pic_set_elcr(uint8_t, uint8_t);
72d326e819Smlarkin uint8_t vcpu_exit_elcr(struct vm_run_params *);
73