WebSVN – HelenOS – Diff – /trunk/kernel/arch/sparc64/src/drivers/fhc.c


/*
 * Copyright (c) 2006 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 sparc64
 * @{
 */
/**
 * @file
 * @brief   FireHose Controller (FHC) driver.
 *
 * Note that this driver is a result of reverse engineering
 * rather than implementation of a specification. This
 * is due to the fact that the FHC documentation is not
 * publicly available.
 */
 
#include <arch/drivers/fhc.h>
#include <arch/trap/interrupt.h>
#include <mm/page.h>
#include <mm/slab.h>
#include <arch/types.h>
#include <genarch/ofw/ofw_tree.h>
#include <sysinfo/sysinfo.h>
 
fhc_t *central_fhc = NULL;
 
/**
 * I suspect this must be hardcoded in the FHC.
 * If it is not, than we can read all IMAP registers
 * and get the complete mapping.
 */
#define FHC_UART_INR    0x39    
 
#define FHC_UART_IMAP   0x0
#define FHC_UART_ICLR   0x4
 
#define UART_IMAP_REG   4
 
fhc_t *fhc_init(ofw_tree_node_t *node)
{
    fhc_t *fhc;
    ofw_tree_property_t *prop;
 
    prop = ofw_tree_getprop(node, "reg");
   
    if (!prop || !prop->value)
        return NULL;
       
    size_t regs = prop->size / sizeof(ofw_central_reg_t);
    if (regs + 1 < UART_IMAP_REG)
        return NULL;
 
    ofw_central_reg_t *reg = &((ofw_central_reg_t *) prop->value)[UART_IMAP_REG];
 
    uintptr_t paddr;
    if (!ofw_central_apply_ranges(node->parent, reg, &paddr))
        return NULL;
 
    fhc = (fhc_t *) malloc(sizeof(fhc_t), FRAME_ATOMIC);
    if (!fhc)
        return NULL;
 
    fhc->uart_imap = (uint32_t *) hw_map(paddr, reg->size);
   
    /*
     * Set sysinfo data needed by the uspace FHC driver.
     */
    sysinfo_set_item_val("fhc.uart.size", NULL, reg->size);
    sysinfo_set_item_val("fhc.uart.physical", NULL, paddr);
    sysinfo_set_item_val("kbd.cir.fhc", NULL, 1);
 
    return fhc;
}
 
void fhc_enable_interrupt(fhc_t *fhc, int inr)
{
    switch (inr) {
    case FHC_UART_INR:
        fhc->uart_imap[FHC_UART_IMAP] |= IMAP_V_MASK;
        break;
    default:
        panic("Unexpected INR (%d).", inr);
        break;
    }
}
 
void fhc_clear_interrupt(void *fhcp, int inr)
{
    fhc_t *fhc = (fhc_t *)fhcp;
    ASSERT(fhc->uart_imap);
 
    switch (inr) {
    case FHC_UART_INR:
        fhc->uart_imap[FHC_UART_ICLR] = 0;
        break;
    default:
        panic("Unexpected INR (%d).", inr);
        break;
    }
}
 
/** @}
 */
 

Rev 3978	Rev 4490
1	/*	1	/*
2	* Copyright (c) 2006 Jakub Jermar	2	* Copyright (c) 2006 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 sparc64	29	/** @addtogroup sparc64
30	* @{	30	* @{
31	*/	31	*/
32	/**	32	/**
33	* @file	33	* @file
34	* @brief FireHose Controller (FHC) driver.	34	* @brief FireHose Controller (FHC) driver.
35	*	35	*
36	* Note that this driver is a result of reverse engineering	36	* Note that this driver is a result of reverse engineering
37	* rather than implementation of a specification. This	37	* rather than implementation of a specification. This
38	* is due to the fact that the FHC documentation is not	38	* is due to the fact that the FHC documentation is not
39	* publicly available.	39	* publicly available.
40	*/	40	*/
41		41
42	#include <arch/drivers/fhc.h>	42	#include <arch/drivers/fhc.h>
43	#include <arch/trap/interrupt.h>	43	#include <arch/trap/interrupt.h>
44	#include <mm/page.h>	44	#include <mm/page.h>
45	#include <mm/slab.h>	45	#include <mm/slab.h>
46	#include <arch/types.h>	46	#include <arch/types.h>
47	#include <genarch/ofw/ofw_tree.h>	47	#include <genarch/ofw/ofw_tree.h>
48	#include <sysinfo/sysinfo.h>	48	#include <sysinfo/sysinfo.h>
49		49
50	fhc_t *central_fhc = NULL;	50	fhc_t *central_fhc = NULL;
51		51
52	/**	52	/**
53	* I suspect this must be hardcoded in the FHC.	53	* I suspect this must be hardcoded in the FHC.
54	* If it is not, than we can read all IMAP registers	54	* If it is not, than we can read all IMAP registers
55	* and get the complete mapping.	55	* and get the complete mapping.
56	*/	56	*/
57	#define FHC_UART_INR 0x39	57	#define FHC_UART_INR 0x39
58		58
59	#define FHC_UART_IMAP 0x0	59	#define FHC_UART_IMAP 0x0
60	#define FHC_UART_ICLR 0x4	60	#define FHC_UART_ICLR 0x4
61		61
62	#define UART_IMAP_REG 4	62	#define UART_IMAP_REG 4
63		63
64	fhc_t fhc_init(ofw_tree_node_t node)	64	fhc_t fhc_init(ofw_tree_node_t node)
65	{	65	{
66	fhc_t *fhc;	66	fhc_t *fhc;
67	ofw_tree_property_t *prop;	67	ofw_tree_property_t *prop;
68		68
69	prop = ofw_tree_getprop(node, "reg");	69	prop = ofw_tree_getprop(node, "reg");
70		70
71	if (!prop \|\| !prop->value)	71	if (!prop \|\| !prop->value)
72	return NULL;	72	return NULL;
73		73
74	count_t regs = prop->size / sizeof(ofw_central_reg_t);	74	size_t regs = prop->size / sizeof(ofw_central_reg_t);
75	if (regs + 1 < UART_IMAP_REG)	75	if (regs + 1 < UART_IMAP_REG)
76	return NULL;	76	return NULL;
77		77
78	ofw_central_reg_t reg = &((ofw_central_reg_t ) prop->value)[UART_IMAP_REG];	78	ofw_central_reg_t reg = &((ofw_central_reg_t ) prop->value)[UART_IMAP_REG];
79		79
80	uintptr_t paddr;	80	uintptr_t paddr;
81	if (!ofw_central_apply_ranges(node->parent, reg, &paddr))	81	if (!ofw_central_apply_ranges(node->parent, reg, &paddr))
82	return NULL;	82	return NULL;
83		83
84	fhc = (fhc_t *) malloc(sizeof(fhc_t), FRAME_ATOMIC);	84	fhc = (fhc_t *) malloc(sizeof(fhc_t), FRAME_ATOMIC);
85	if (!fhc)	85	if (!fhc)
86	return NULL;	86	return NULL;
87		87
88	fhc->uart_imap = (uint32_t *) hw_map(paddr, reg->size);	88	fhc->uart_imap = (uint32_t *) hw_map(paddr, reg->size);
89		89
90	/*	90	/*
91	* Set sysinfo data needed by the uspace FHC driver.	91	* Set sysinfo data needed by the uspace FHC driver.
92	*/	92	*/
93	sysinfo_set_item_val("fhc.uart.size", NULL, reg->size);	93	sysinfo_set_item_val("fhc.uart.size", NULL, reg->size);
94	sysinfo_set_item_val("fhc.uart.physical", NULL, paddr);	94	sysinfo_set_item_val("fhc.uart.physical", NULL, paddr);
95	sysinfo_set_item_val("kbd.cir.fhc", NULL, 1);	95	sysinfo_set_item_val("kbd.cir.fhc", NULL, 1);
96		96
97	return fhc;	97	return fhc;
98	}	98	}
99		99
100	void fhc_enable_interrupt(fhc_t *fhc, int inr)	100	void fhc_enable_interrupt(fhc_t *fhc, int inr)
101	{	101	{
102	switch (inr) {	102	switch (inr) {
103	case FHC_UART_INR:	103	case FHC_UART_INR:
104	fhc->uart_imap[FHC_UART_IMAP] \|= IMAP_V_MASK;	104	fhc->uart_imap[FHC_UART_IMAP] \|= IMAP_V_MASK;
105	break;	105	break;
106	default:	106	default:
107	panic("Unexpected INR (%d).", inr);	107	panic("Unexpected INR (%d).", inr);
108	break;	108	break;
109	}	109	}
110	}	110	}
111		111
112	void fhc_clear_interrupt(void *fhcp, int inr)	112	void fhc_clear_interrupt(void *fhcp, int inr)
113	{	113	{
114	fhc_t fhc = (fhc_t )fhcp;	114	fhc_t fhc = (fhc_t )fhcp;
115	ASSERT(fhc->uart_imap);	115	ASSERT(fhc->uart_imap);
116		116
117	switch (inr) {	117	switch (inr) {
118	case FHC_UART_INR:	118	case FHC_UART_INR:
119	fhc->uart_imap[FHC_UART_ICLR] = 0;	119	fhc->uart_imap[FHC_UART_ICLR] = 0;
120	break;	120	break;
121	default:	121	default:
122	panic("Unexpected INR (%d).", inr);	122	panic("Unexpected INR (%d).", inr);
123	break;	123	break;
124	}	124	}
125	}	125	}
126		126
127	/** @}	127	/** @}
128	*/	128	*/
129		129

Subversion Repositories HelenOS

(root)/trunk/kernel/arch/sparc64/src/drivers/fhc.c @ 2316 – Rev 3978 → 4490