xref: /illumos-gate/usr/src/uts/intel/io/vmm/io/vrtc.h (revision 32640292)
14c87aefeSPatrick Mooney /*-
2*32640292SAndy Fiddaman  * SPDX-License-Identifier: BSD-2-Clause
34c87aefeSPatrick Mooney  *
44c87aefeSPatrick Mooney  * Copyright (c) 2014 Neel Natu (neel@freebsd.org)
54c87aefeSPatrick Mooney  * All rights reserved.
64c87aefeSPatrick Mooney  *
74c87aefeSPatrick Mooney  * Redistribution and use in source and binary forms, with or without
84c87aefeSPatrick Mooney  * modification, are permitted provided that the following conditions
94c87aefeSPatrick Mooney  * are met:
104c87aefeSPatrick Mooney  * 1. Redistributions of source code must retain the above copyright
114c87aefeSPatrick Mooney  *    notice unmodified, this list of conditions, and the following
124c87aefeSPatrick Mooney  *    disclaimer.
134c87aefeSPatrick Mooney  * 2. Redistributions in binary form must reproduce the above copyright
144c87aefeSPatrick Mooney  *    notice, this list of conditions and the following disclaimer in the
154c87aefeSPatrick Mooney  *    documentation and/or other materials provided with the distribution.
164c87aefeSPatrick Mooney  *
174c87aefeSPatrick Mooney  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
184c87aefeSPatrick Mooney  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
194c87aefeSPatrick Mooney  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
204c87aefeSPatrick Mooney  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
214c87aefeSPatrick Mooney  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
224c87aefeSPatrick Mooney  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
234c87aefeSPatrick Mooney  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
244c87aefeSPatrick Mooney  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
254c87aefeSPatrick Mooney  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
264c87aefeSPatrick Mooney  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
274c87aefeSPatrick Mooney  */
284c87aefeSPatrick Mooney 
294c87aefeSPatrick Mooney /*
304c87aefeSPatrick Mooney  * Copyright 2018 Joyent, Inc.
31a1d41cf9SPatrick Mooney  * Copyright 2023 Oxide Computer Company
324c87aefeSPatrick Mooney  */
334c87aefeSPatrick Mooney 
344c87aefeSPatrick Mooney #ifndef _VRTC_H_
354c87aefeSPatrick Mooney #define	_VRTC_H_
364c87aefeSPatrick Mooney 
374c87aefeSPatrick Mooney #include <isa/isareg.h>
384c87aefeSPatrick Mooney 
394c87aefeSPatrick Mooney struct vrtc;
404c87aefeSPatrick Mooney 
414c87aefeSPatrick Mooney struct vrtc *vrtc_init(struct vm *vm);
424c87aefeSPatrick Mooney void vrtc_cleanup(struct vrtc *vrtc);
434c87aefeSPatrick Mooney void vrtc_reset(struct vrtc *vrtc);
444c87aefeSPatrick Mooney 
45a1d41cf9SPatrick Mooney void vrtc_get_time(struct vm *vm, timespec_t *);
46a1d41cf9SPatrick Mooney int vrtc_set_time(struct vm *vm, const timespec_t *);
474c87aefeSPatrick Mooney int vrtc_nvram_write(struct vm *vm, int offset, uint8_t value);
484c87aefeSPatrick Mooney int vrtc_nvram_read(struct vm *vm, int offset, uint8_t *retval);
494c87aefeSPatrick Mooney 
500e1453c3SPatrick Mooney int vrtc_addr_handler(void *arg, bool in, uint16_t port, uint8_t bytes,
510e1453c3SPatrick Mooney     uint32_t *val);
520e1453c3SPatrick Mooney int vrtc_data_handler(void *arg, bool in, uint16_t port, uint8_t bytes,
530e1453c3SPatrick Mooney     uint32_t *val);
544c87aefeSPatrick Mooney 
554c87aefeSPatrick Mooney void vrtc_localize_resources(struct vrtc *);
562cac0506SPatrick Mooney void vrtc_pause(struct vrtc *);
572cac0506SPatrick Mooney void vrtc_resume(struct vrtc *);
584c87aefeSPatrick Mooney 
594c87aefeSPatrick Mooney #endif
60