xref: /freebsd/sys/amd64/vmm/io/vatpic.h (revision 7899f917b1c0ea178f1d2be0cfb452086d079d23)
1 /*-
2  * Copyright (c) 2014 Tycho Nightingale <tycho.nightingale@pluribusnetworks.com>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #ifndef _VATPIC_H_
28 #define	_VATPIC_H_
29 
30 #include <isa/isareg.h>
31 
32 #define	ICU_IMR_OFFSET	1
33 
34 #define	IO_ELCR1	0x4d0
35 #define	IO_ELCR2	0x4d1
36 
37 struct vm_snapshot_meta;
38 
39 struct vatpic *vatpic_init(struct vm *vm);
40 void vatpic_cleanup(struct vatpic *vatpic);
41 
42 int vatpic_master_handler(struct vm *vm, bool in, int port, int bytes,
43     uint32_t *eax);
44 int vatpic_slave_handler(struct vm *vm, bool in, int port, int bytes,
45     uint32_t *eax);
46 int vatpic_elc_handler(struct vm *vm, bool in, int port, int bytes,
47     uint32_t *eax);
48 
49 int vatpic_assert_irq(struct vm *vm, int irq);
50 int vatpic_deassert_irq(struct vm *vm, int irq);
51 int vatpic_pulse_irq(struct vm *vm, int irq);
52 int vatpic_set_irq_trigger(struct vm *vm, int irq, enum vm_intr_trigger trigger);
53 
54 void vatpic_pending_intr(struct vm *vm, int *vecptr);
55 void vatpic_intr_accepted(struct vm *vm, int vector);
56 
57 #ifdef BHYVE_SNAPSHOT
58 int vatpic_snapshot(struct vatpic *vatpic, struct vm_snapshot_meta *meta);
59 #endif
60 
61 #endif	/* _VATPIC_H_ */
62