xref: /onnv-gate/usr/src/uts/sun4/sys/bbc_beep.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright (c) 1999-2000 by Sun Microsystems, Inc.
24*0Sstevel@tonic-gate  * All rights reserved.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _SYS_BBC_BEEP_H
28*0Sstevel@tonic-gate #define	_SYS_BBC_BEEP_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef __cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate /*
37*0Sstevel@tonic-gate  * bbc_beep.h : BBC beep driver's header file.
38*0Sstevel@tonic-gate  */
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate /* Keyboard Beep Control Register values */
41*0Sstevel@tonic-gate #define	BBC_BEEP_ON		0x01
42*0Sstevel@tonic-gate #define	BBC_BEEP_OFF		0x00
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate /*
45*0Sstevel@tonic-gate  * Keyboard Beep Counter Register value :
46*0Sstevel@tonic-gate  * The most significant of [18..10] selects the bit of
47*0Sstevel@tonic-gate  * the BBC free running counter (updated on half the system
48*0Sstevel@tonic-gate  * clock) that is used to generate the audio signal. So, bit[10]
49*0Sstevel@tonic-gate  * generates a signal at 1/(2^12) the system frequency, and
50*0Sstevel@tonic-gate  * bit[18], at 1/(2^20). So if s = system frequency(in MHz),
51*0Sstevel@tonic-gate  * it can generate frequencies in the range (s >> 10) Hz to
52*0Sstevel@tonic-gate  * (s >> 2) Hz.
53*0Sstevel@tonic-gate  */
54*0Sstevel@tonic-gate #define	BBC_BEEP_MIN_SHIFT	20
55*0Sstevel@tonic-gate #define	BBC_BEEP_MAX_SHIFT	12
56*0Sstevel@tonic-gate #define	BBC_BEEP_MSBIT		18
57*0Sstevel@tonic-gate 
58*0Sstevel@tonic-gate typedef volatile struct bbc_beep_regs {
59*0Sstevel@tonic-gate 
60*0Sstevel@tonic-gate 	/* Beep ON/OFF register */
61*0Sstevel@tonic-gate 	uint8_t		bbc_beep_control;
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate 	/* Reserved */
64*0Sstevel@tonic-gate 	uint8_t		reserved;
65*0Sstevel@tonic-gate 
66*0Sstevel@tonic-gate 	/* Register to set the frequency */
67*0Sstevel@tonic-gate 	uint8_t		bbc_beep_counter[4];
68*0Sstevel@tonic-gate 
69*0Sstevel@tonic-gate } bbc_beep_regs_t;
70*0Sstevel@tonic-gate 
71*0Sstevel@tonic-gate /*
72*0Sstevel@tonic-gate  * Beep driver state structure
73*0Sstevel@tonic-gate  */
74*0Sstevel@tonic-gate typedef struct bbc_beep_state {
75*0Sstevel@tonic-gate 
76*0Sstevel@tonic-gate 	/* Dip of bbc_beep device */
77*0Sstevel@tonic-gate 	dev_info_t		*bbc_beep_dip;
78*0Sstevel@tonic-gate 
79*0Sstevel@tonic-gate 	/* Beep registers */
80*0Sstevel@tonic-gate 	bbc_beep_regs_t		*bbc_beep_regsp;
81*0Sstevel@tonic-gate 
82*0Sstevel@tonic-gate 	/* Register handle */
83*0Sstevel@tonic-gate 	ddi_acc_handle_t	bbc_beep_regs_handle;
84*0Sstevel@tonic-gate 
85*0Sstevel@tonic-gate 	/* If beeper is active or not */
86*0Sstevel@tonic-gate 	int			bbc_beep_mode;
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate 	} bbc_beep_state_t;
89*0Sstevel@tonic-gate 
90*0Sstevel@tonic-gate #define	BEEP_WRITE_CTRL_REG(val) ddi_put8(bbc_beeptr->bbc_beep_regs_handle, \
91*0Sstevel@tonic-gate 		((uint8_t *)&bbc_beeptr->bbc_beep_regsp->bbc_beep_control), \
92*0Sstevel@tonic-gate 					((int8_t)(val)))
93*0Sstevel@tonic-gate #define	BEEP_WRITE_COUNTER_REG(no, val) \
94*0Sstevel@tonic-gate 		ddi_put8(bbc_beeptr->bbc_beep_regs_handle, \
95*0Sstevel@tonic-gate 	((uint8_t *)&bbc_beeptr->bbc_beep_regsp->bbc_beep_counter[no]), \
96*0Sstevel@tonic-gate 					((int8_t)(val)))
97*0Sstevel@tonic-gate 
98*0Sstevel@tonic-gate #define	BEEP_UNIT(dev)	(getminor((dev)))
99*0Sstevel@tonic-gate 
100*0Sstevel@tonic-gate #ifdef __cplusplus
101*0Sstevel@tonic-gate }
102*0Sstevel@tonic-gate #endif
103*0Sstevel@tonic-gate 
104*0Sstevel@tonic-gate #endif /* _SYS_BBC_BEEP_H */
105