xref: /aosp_15_r20/external/kernel-headers/original/uapi/linux/mmtimer.h (revision f80ad8b4341604f5951dab671d41019a6d7087ce)
1*f80ad8b4SAndroid Build Coastguard Worker /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
2*f80ad8b4SAndroid Build Coastguard Worker /*
3*f80ad8b4SAndroid Build Coastguard Worker  * Intel Multimedia Timer device interface
4*f80ad8b4SAndroid Build Coastguard Worker  *
5*f80ad8b4SAndroid Build Coastguard Worker  * This file is subject to the terms and conditions of the GNU General Public
6*f80ad8b4SAndroid Build Coastguard Worker  * License.  See the file "COPYING" in the main directory of this archive
7*f80ad8b4SAndroid Build Coastguard Worker  * for more details.
8*f80ad8b4SAndroid Build Coastguard Worker  *
9*f80ad8b4SAndroid Build Coastguard Worker  * Copyright (c) 2001-2004 Silicon Graphics, Inc.  All rights reserved.
10*f80ad8b4SAndroid Build Coastguard Worker  *
11*f80ad8b4SAndroid Build Coastguard Worker  * This file should define an interface compatible with the IA-PC Multimedia
12*f80ad8b4SAndroid Build Coastguard Worker  * Timers Draft Specification (rev. 0.97) from Intel.  Note that some
13*f80ad8b4SAndroid Build Coastguard Worker  * hardware may not be able to safely export its registers to userspace,
14*f80ad8b4SAndroid Build Coastguard Worker  * so the ioctl interface should support all necessary functionality.
15*f80ad8b4SAndroid Build Coastguard Worker  *
16*f80ad8b4SAndroid Build Coastguard Worker  * 11/01/01 - jbarnes - initial revision
17*f80ad8b4SAndroid Build Coastguard Worker  * 9/10/04 - Christoph Lameter - remove interrupt support
18*f80ad8b4SAndroid Build Coastguard Worker  * 9/17/04 - jbarnes - remove test program, move some #defines to the driver
19*f80ad8b4SAndroid Build Coastguard Worker  */
20*f80ad8b4SAndroid Build Coastguard Worker 
21*f80ad8b4SAndroid Build Coastguard Worker #ifndef _LINUX_MMTIMER_H
22*f80ad8b4SAndroid Build Coastguard Worker #define _LINUX_MMTIMER_H
23*f80ad8b4SAndroid Build Coastguard Worker 
24*f80ad8b4SAndroid Build Coastguard Worker /*
25*f80ad8b4SAndroid Build Coastguard Worker  * Breakdown of the ioctl's available.  An 'optional' next to the command
26*f80ad8b4SAndroid Build Coastguard Worker  * indicates that supporting this command is optional, while 'required'
27*f80ad8b4SAndroid Build Coastguard Worker  * commands must be implemented if conformance is desired.
28*f80ad8b4SAndroid Build Coastguard Worker  *
29*f80ad8b4SAndroid Build Coastguard Worker  * MMTIMER_GETOFFSET - optional
30*f80ad8b4SAndroid Build Coastguard Worker  *   Should return the offset (relative to the start of the page where the
31*f80ad8b4SAndroid Build Coastguard Worker  *   registers are mapped) for the counter in question.
32*f80ad8b4SAndroid Build Coastguard Worker  *
33*f80ad8b4SAndroid Build Coastguard Worker  * MMTIMER_GETRES - required
34*f80ad8b4SAndroid Build Coastguard Worker  *   The resolution of the clock in femto (10^-15) seconds
35*f80ad8b4SAndroid Build Coastguard Worker  *
36*f80ad8b4SAndroid Build Coastguard Worker  * MMTIMER_GETFREQ - required
37*f80ad8b4SAndroid Build Coastguard Worker  *   Frequency of the clock in Hz
38*f80ad8b4SAndroid Build Coastguard Worker  *
39*f80ad8b4SAndroid Build Coastguard Worker  * MMTIMER_GETBITS - required
40*f80ad8b4SAndroid Build Coastguard Worker  *   Number of bits in the clock's counter
41*f80ad8b4SAndroid Build Coastguard Worker  *
42*f80ad8b4SAndroid Build Coastguard Worker  * MMTIMER_MMAPAVAIL - required
43*f80ad8b4SAndroid Build Coastguard Worker  *   Returns nonzero if the registers can be mmap'd into userspace, 0 otherwise
44*f80ad8b4SAndroid Build Coastguard Worker  *
45*f80ad8b4SAndroid Build Coastguard Worker  * MMTIMER_GETCOUNTER - required
46*f80ad8b4SAndroid Build Coastguard Worker  *   Gets the current value in the counter
47*f80ad8b4SAndroid Build Coastguard Worker  */
48*f80ad8b4SAndroid Build Coastguard Worker #define MMTIMER_IOCTL_BASE 'm'
49*f80ad8b4SAndroid Build Coastguard Worker 
50*f80ad8b4SAndroid Build Coastguard Worker #define MMTIMER_GETOFFSET _IO(MMTIMER_IOCTL_BASE, 0)
51*f80ad8b4SAndroid Build Coastguard Worker #define MMTIMER_GETRES _IOR(MMTIMER_IOCTL_BASE, 1, unsigned long)
52*f80ad8b4SAndroid Build Coastguard Worker #define MMTIMER_GETFREQ _IOR(MMTIMER_IOCTL_BASE, 2, unsigned long)
53*f80ad8b4SAndroid Build Coastguard Worker #define MMTIMER_GETBITS _IO(MMTIMER_IOCTL_BASE, 4)
54*f80ad8b4SAndroid Build Coastguard Worker #define MMTIMER_MMAPAVAIL _IO(MMTIMER_IOCTL_BASE, 6)
55*f80ad8b4SAndroid Build Coastguard Worker #define MMTIMER_GETCOUNTER _IOR(MMTIMER_IOCTL_BASE, 9, unsigned long)
56*f80ad8b4SAndroid Build Coastguard Worker 
57*f80ad8b4SAndroid Build Coastguard Worker #endif /* _LINUX_MMTIMER_H */
58