WebSVN – HelenOS – Diff – /trunk/kernel/genarch/include/drivers/z8530/z8530.h


/*
 * Copyright (c) 2009 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
/** @addtogroup genarch
 * @{
 */
/**
 * @file
 * @brief   Headers for Zilog 8530 serial controller.
 */
 
#ifndef KERN_Z8530_H_
#define KERN_Z8530_H_
 
#include <ddi/irq.h>
#include <arch/types.h>
#include <console/chardev.h>
 
#define WR0 0
#define WR1 1
#define WR2 2
#define WR3 3
#define WR4 4
#define WR5 5
#define WR6 6
#define WR7 7
#define WR8 8
#define WR9 9
#define WR10    10
#define WR11    11
#define WR12    12
#define WR13    13
#define WR14    14
#define WR15    15
 
#define RR0 0
#define RR1 1
#define RR2 2
#define RR3 3
#define RR8 8
#define RR10    10
#define RR12    12
#define RR13    13
#define RR14    14
#define RR15    15
 
/** Reset pending TX interrupt. */
#define WR0_TX_IP_RST   (0x5 << 3)
#define WR0_ERR_RST (0x6 << 3)
 
/** Receive Interrupts Disabled. */
#define WR1_RID     (0x0 << 3)
/** Receive Interrupt on First Character or Special Condition. */
#define WR1_RIFCSC  (0x1 << 3)
/** Interrupt on All Receive Characters or Special Conditions. */
#define WR1_IARCSC  (0x2 << 3)
/** Receive Interrupt on Special Condition. */
#define WR1_RISC    (0x3 << 3)
/** Parity Is Special Condition. */
#define WR1_PISC    (0x1 << 2)
 
/** Rx Enable. */
#define WR3_RX_ENABLE   (0x1 << 0)
/** 8-bits per character. */
#define WR3_RX8BITSCH   (0x3 << 6)
 
/** Master Interrupt Enable. */
#define WR9_MIE     (0x1 << 3)
 
/** Receive Character Available. */
#define RR0_RCA     (0x1 << 0)
 
/** z8530's registers. */
struct z8530 {
    union {
        ioport8_t ctl_b;
        ioport8_t status_b;
    } __attribute__ ((packed));
    uint8_t pad1;
    ioport8_t data_b;
    uint8_t pad2;
    union {
        ioport8_t ctl_a;
        ioport8_t status_a;
    } __attribute__ ((packed));
    uint8_t pad3;
    ioport8_t data_a;
} __attribute__ ((packed));
typedef struct z8530 z8530_t;
 
/** Structure representing the z8530 device. */
typedef struct {
    devno_t devno;
    irq_t irq;
    z8530_t *z8530;
    chardev_t *devout;
} z8530_instance_t;
 
extern bool z8530_init(z8530_t *, devno_t, inr_t, cir_t, void *, chardev_t *);
extern irq_ownership_t z8530_claim(irq_t *);
extern void z8530_irq_handler(irq_t *);
 
#endif
 
/** @}
 */
 

Rev 3961	Rev 4042
1	/*	1	/*
2	* Copyright (c) 2001-2004 Jakub Jermar	2	* Copyright (c) 2009 Jakub Jermar
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	/** @addtogroup genarch	29	/** @addtogroup genarch
30	* @{	30	* @{
31	*/	31	*/
32	/**	32	/**
33	* @file	33	* @file
34	* @brief Headers for Zilog 8530 serial port / keyboard driver.	34	* @brief Headers for Zilog 8530 serial controller.
35	*/	35	*/
36		36
37	#ifndef KERN_Z8530_H_	37	#ifndef KERN_Z8530_H_
38	#define KERN_Z8530_H_	38	#define KERN_Z8530_H_
39		39
40	#include <ddi/irq.h>	40	#include <ddi/irq.h>
41	#include <arch/types.h>	41	#include <arch/types.h>
-		42	#include <console/chardev.h>
42		43
43	#define WR0 0	44	#define WR0 0
44	#define WR1 1	45	#define WR1 1
45	#define WR2 2	46	#define WR2 2
46	#define WR3 3	47	#define WR3 3
47	#define WR4 4	48	#define WR4 4
48	#define WR5 5	49	#define WR5 5
49	#define WR6 6	50	#define WR6 6
50	#define WR7 7	51	#define WR7 7
51	#define WR8 8	52	#define WR8 8
52	#define WR9 9	53	#define WR9 9
53	#define WR10 10	54	#define WR10 10
54	#define WR11 11	55	#define WR11 11
55	#define WR12 12	56	#define WR12 12
56	#define WR13 13	57	#define WR13 13
57	#define WR14 14	58	#define WR14 14
58	#define WR15 15	59	#define WR15 15
59		60
60	#define RR0 0	61	#define RR0 0
61	#define RR1 1	62	#define RR1 1
62	#define RR2 2	63	#define RR2 2
63	#define RR3 3	64	#define RR3 3
64	#define RR8 8	65	#define RR8 8
65	#define RR10 10	66	#define RR10 10
66	#define RR12 12	67	#define RR12 12
67	#define RR13 13	68	#define RR13 13
68	#define RR14 14	69	#define RR14 14
69	#define RR15 15	70	#define RR15 15
70		71
71	/** Reset pending TX interrupt. */	72	/** Reset pending TX interrupt. */
72	#define WR0_TX_IP_RST (0x5 << 3)	73	#define WR0_TX_IP_RST (0x5 << 3)
73	#define WR0_ERR_RST (0x6 << 3)	74	#define WR0_ERR_RST (0x6 << 3)
74		75
75	/** Receive Interrupts Disabled. */	76	/** Receive Interrupts Disabled. */
76	#define WR1_RID (0x0 << 3)	77	#define WR1_RID (0x0 << 3)
77	/** Receive Interrupt on First Character or Special Condition. */	78	/** Receive Interrupt on First Character or Special Condition. */
78	#define WR1_RIFCSC (0x1 << 3)	79	#define WR1_RIFCSC (0x1 << 3)
79	/** Interrupt on All Receive Characters or Special Conditions. */	80	/** Interrupt on All Receive Characters or Special Conditions. */
80	#define WR1_IARCSC (0x2 << 3)	81	#define WR1_IARCSC (0x2 << 3)
81	/** Receive Interrupt on Special Condition. */	82	/** Receive Interrupt on Special Condition. */
82	#define WR1_RISC (0x3 << 3)	83	#define WR1_RISC (0x3 << 3)
83	/** Parity Is Special Condition. */	84	/** Parity Is Special Condition. */
84	#define WR1_PISC (0x1 << 2)	85	#define WR1_PISC (0x1 << 2)
85		86
86	/** Rx Enable. */	87	/** Rx Enable. */
87	#define WR3_RX_ENABLE (0x1 << 0)	88	#define WR3_RX_ENABLE (0x1 << 0)
88	/** 8-bits per character. */	89	/** 8-bits per character. */
89	#define WR3_RX8BITSCH (0x3 << 6)	90	#define WR3_RX8BITSCH (0x3 << 6)
90		91
91	/** Master Interrupt Enable. */	92	/** Master Interrupt Enable. */
92	#define WR9_MIE (0x1 << 3)	93	#define WR9_MIE (0x1 << 3)
93		94
94	/** Receive Character Available. */	95	/** Receive Character Available. */
95	#define RR0_RCA (0x1 << 0)	96	#define RR0_RCA (0x1 << 0)
96		97
97	/** z8530's registers. */	98	/** z8530's registers. */
98	struct z8530 {	99	struct z8530 {
99	union {	100	union {
100	ioport8_t ctl_b;	101	ioport8_t ctl_b;
101	ioport8_t status_b;	102	ioport8_t status_b;
102	} __attribute__ ((packed));	103	} __attribute__ ((packed));
103	uint8_t pad1;	104	uint8_t pad1;
104	ioport8_t data_b;	105	ioport8_t data_b;
105	uint8_t pad2;	106	uint8_t pad2;
106	union {	107	union {
107	ioport8_t ctl_a;	108	ioport8_t ctl_a;
108	ioport8_t status_a;	109	ioport8_t status_a;
109	} __attribute__ ((packed));	110	} __attribute__ ((packed));
110	uint8_t pad3;	111	uint8_t pad3;
111	ioport8_t data_a;	112	ioport8_t data_a;
112	} __attribute__ ((packed));	113	} __attribute__ ((packed));
113	typedef struct z8530 z8530_t;	114	typedef struct z8530 z8530_t;
114		115
115	/** Structure representing the z8530 device. */	116	/** Structure representing the z8530 device. */
116	typedef struct {	117	typedef struct {
117	devno_t devno;	118	devno_t devno;
118	irq_t irq;	119	irq_t irq;
119	z8530_t *z8530;	120	z8530_t *z8530;
-		121	chardev_t *devout;
120	} z8530_instance_t;	122	} z8530_instance_t;
121		123
122	extern bool z8530_init(z8530_t , devno_t, inr_t, cir_t, void );	124	extern bool z8530_init(z8530_t , devno_t, inr_t, cir_t, void , chardev_t *);
123	extern irq_ownership_t z8530_claim(irq_t *);	125	extern irq_ownership_t z8530_claim(irq_t *);
124	extern void z8530_irq_handler(irq_t *);	126	extern void z8530_irq_handler(irq_t *);
125		127
126	#endif	128	#endif
127		129
128	/** @}	130	/** @}
129	*/	131	*/
130		132

Subversion Repositories HelenOS

(root)/trunk/kernel/genarch/include/drivers/z8530/z8530.h – Rev 3961 → 4042