WebSVN – HelenOS – Diff – /tags/0.4.1/uspace/srv/kbd/port/sgcn.c


/*
 * Copyright (c) 2008 Pavel Rimsky
 * 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 kbd_port
 * @ingroup  kbd
 * @{
 */
/** @file
 * @brief   SGCN (Serengeti Console) keyboard port driver.
 */
 
#include <as.h>
#include <ddi.h>
#include <async.h>
#include <kbd.h>
#include <kbd_port.h>
#include <sysinfo.h>
#include <stdio.h>
#include <thread.h>
#include <bool.h>
 
#define POLL_INTERVAL       10000
 
/**
 * SGCN buffer header. It is placed at the very beginning of the SGCN
 * buffer.
 */
typedef struct {
    /** hard-wired to "CON" */
    char magic[4];
   
    /** we don't need this */
    char unused[8];
   
    /** offset within the SGCN buffer of the input buffer start */
    uint32_t in_begin;
   
    /** offset within the SGCN buffer of the input buffer end */
    uint32_t in_end;
   
    /** offset within the SGCN buffer of the input buffer read pointer */
    uint32_t in_rdptr;
   
    /** offset within the SGCN buffer of the input buffer write pointer */
    uint32_t in_wrptr;
} __attribute__ ((packed)) sgcn_buffer_header_t;
 
/*
 * Returns a pointer to the object of a given type which is placed at the given
 * offset from the console buffer beginning.
 */
#define SGCN_BUFFER(type, offset) \
        ((type *) (sram_virt_addr + sram_buffer_offset + (offset)))
 
/** Returns a pointer to the console buffer header. */
#define SGCN_BUFFER_HEADER  (SGCN_BUFFER(sgcn_buffer_header_t, 0))
 
/**
 * Virtual address mapped to SRAM.
 */
static uintptr_t sram_virt_addr;
 
/**
 * SGCN buffer offset within SGCN.
 */
static uintptr_t sram_buffer_offset;
 
/* polling thread */
static void *sgcn_thread_impl(void *arg);
 
static volatile bool polling_disabled = false;
 
/**
 * Initializes the SGCN driver.
 * Maps the physical memory (SRAM) and creates the polling thread.
 */
int kbd_port_init(void)
{
    sram_virt_addr = (uintptr_t) as_get_mappable_page(sysinfo_value("sram.area.size"));
    if (physmem_map((void *) sysinfo_value("sram.address.physical"),
        (void *) sram_virt_addr, sysinfo_value("sram.area.size") / PAGE_SIZE,
        AS_AREA_READ | AS_AREA_WRITE) != 0) {
        printf("SGCN: uspace driver could not map physical memory.");
        return -1;
    }
   
    sram_buffer_offset = sysinfo_value("sram.buffer.offset");
 
    thread_id_t tid;
    int rc;
 
    rc = thread_create(sgcn_thread_impl, NULL, "kbd_poll", &tid);
    if (rc != 0) {
        return rc;
    }
 
    return 0;
}
 
void kbd_port_yield(void)
{
    polling_disabled = true;
}
 
void kbd_port_reclaim(void)
{
    polling_disabled = false;
}
 
/**
 * Handler of the "key pressed" event. Reads codes of all the pressed keys from
 * the buffer.
 */
static void sgcn_key_pressed(void)
{
    char c;
   
    uint32_t begin = SGCN_BUFFER_HEADER->in_begin;
    uint32_t end = SGCN_BUFFER_HEADER->in_end;
    uint32_t size = end - begin;
   
    volatile char *buf_ptr = (volatile char *)
        SGCN_BUFFER(char, SGCN_BUFFER_HEADER->in_rdptr);
    volatile uint32_t *in_wrptr_ptr = &(SGCN_BUFFER_HEADER->in_wrptr);
    volatile uint32_t *in_rdptr_ptr = &(SGCN_BUFFER_HEADER->in_rdptr);
   
    while (*in_rdptr_ptr != *in_wrptr_ptr) {
        c = *buf_ptr;
        *in_rdptr_ptr = (((*in_rdptr_ptr) - begin + 1) % size) + begin;
        buf_ptr = (volatile char *)
            SGCN_BUFFER(char, SGCN_BUFFER_HEADER->in_rdptr);
        kbd_push_scancode(c);
    }
}
 
/**
 * Thread to poll SGCN for keypresses.
 */
static void *sgcn_thread_impl(void *arg)
{
    (void) arg;
 
    while (1) {
        if (polling_disabled == false)
            sgcn_key_pressed();
        usleep(POLL_INTERVAL);
    }
}
 
/** @}
 */
 

Rev 4330	Rev 4687
1	/*	1	/*
2	* Copyright (c) 2008 Pavel Rimsky	2	* Copyright (c) 2008 Pavel Rimsky
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 kbd_port	29	/** @addtogroup kbd_port
30	* @ingroup kbd	30	* @ingroup kbd
31	* @{	31	* @{
32	*/	32	*/
33	/** @file	33	/** @file
34	* @brief SGCN (Serengeti Console) keyboard port driver.	34	* @brief SGCN (Serengeti Console) keyboard port driver.
35	*/	35	*/
36		36
37	#include <as.h>	37	#include <as.h>
38	#include <ddi.h>	38	#include <ddi.h>
39	#include <async.h>	39	#include <async.h>
40	#include <kbd.h>	40	#include <kbd.h>
41	#include <kbd_port.h>	41	#include <kbd_port.h>
42	#include <sysinfo.h>	42	#include <sysinfo.h>
43	#include <stdio.h>	43	#include <stdio.h>
44	#include <thread.h>	44	#include <thread.h>
45	#include <bool.h>	45	#include <bool.h>
46		46
47	#define POLL_INTERVAL 10000	47	#define POLL_INTERVAL 10000
48		48
49	/**	49	/**
50	* SGCN buffer header. It is placed at the very beginning of the SGCN	50	* SGCN buffer header. It is placed at the very beginning of the SGCN
51	* buffer.	51	* buffer.
52	*/	52	*/
53	typedef struct {	53	typedef struct {
54	/** hard-wired to "CON" */	54	/** hard-wired to "CON" */
55	char magic[4];	55	char magic[4];
56		56
57	/** we don't need this */	57	/** we don't need this */
58	char unused[8];	58	char unused[8];
59		59
60	/** offset within the SGCN buffer of the input buffer start */	60	/** offset within the SGCN buffer of the input buffer start */
61	uint32_t in_begin;	61	uint32_t in_begin;
62		62
63	/** offset within the SGCN buffer of the input buffer end */	63	/** offset within the SGCN buffer of the input buffer end */
64	uint32_t in_end;	64	uint32_t in_end;
65		65
66	/** offset within the SGCN buffer of the input buffer read pointer */	66	/** offset within the SGCN buffer of the input buffer read pointer */
67	uint32_t in_rdptr;	67	uint32_t in_rdptr;
68		68
69	/** offset within the SGCN buffer of the input buffer write pointer */	69	/** offset within the SGCN buffer of the input buffer write pointer */
70	uint32_t in_wrptr;	70	uint32_t in_wrptr;
71	} __attribute__ ((packed)) sgcn_buffer_header_t;	71	} __attribute__ ((packed)) sgcn_buffer_header_t;
72		72
73	/*	73	/*
74	* Returns a pointer to the object of a given type which is placed at the given	74	* Returns a pointer to the object of a given type which is placed at the given
75	* offset from the console buffer beginning.	75	* offset from the console buffer beginning.
76	*/	76	*/
77	#define SGCN_BUFFER(type, offset) \	77	#define SGCN_BUFFER(type, offset) \
78	((type *) (sram_virt_addr + sram_buffer_offset + (offset)))	78	((type *) (sram_virt_addr + sram_buffer_offset + (offset)))
79		79
80	/** Returns a pointer to the console buffer header. */	80	/** Returns a pointer to the console buffer header. */
81	#define SGCN_BUFFER_HEADER (SGCN_BUFFER(sgcn_buffer_header_t, 0))	81	#define SGCN_BUFFER_HEADER (SGCN_BUFFER(sgcn_buffer_header_t, 0))
82		82
83	/**	83	/**
84	* Virtual address mapped to SRAM.	84	* Virtual address mapped to SRAM.
85	*/	85	*/
86	static uintptr_t sram_virt_addr;	86	static uintptr_t sram_virt_addr;
87		87
88	/**	88	/**
89	* SGCN buffer offset within SGCN.	89	* SGCN buffer offset within SGCN.
90	*/	90	*/
91	static uintptr_t sram_buffer_offset;	91	static uintptr_t sram_buffer_offset;
92		92
93	/* polling thread */	93	/* polling thread */
94	static void sgcn_thread_impl(void arg);	94	static void sgcn_thread_impl(void arg);
95		95
96	static volatile bool polling_disabled = false;	96	static volatile bool polling_disabled = false;
97		97
98	/**	98	/**
99	* Initializes the SGCN driver.	99	* Initializes the SGCN driver.
100	* Maps the physical memory (SRAM) and creates the polling thread.	100	* Maps the physical memory (SRAM) and creates the polling thread.
101	*/	101	*/
102	int kbd_port_init(void)	102	int kbd_port_init(void)
103	{	103	{
104	sram_virt_addr = (uintptr_t) as_get_mappable_page(sysinfo_value("sram.area.size"));	104	sram_virt_addr = (uintptr_t) as_get_mappable_page(sysinfo_value("sram.area.size"));
105	if (physmem_map((void *) sysinfo_value("sram.address.physical"),	105	if (physmem_map((void *) sysinfo_value("sram.address.physical"),
106	(void *) sram_virt_addr, sysinfo_value("sram.area.size") / PAGE_SIZE,	106	(void *) sram_virt_addr, sysinfo_value("sram.area.size") / PAGE_SIZE,
107	AS_AREA_READ \| AS_AREA_WRITE) != 0) {	107	AS_AREA_READ \| AS_AREA_WRITE) != 0) {
108	printf("SGCN: uspace driver could not map physical memory.");	108	printf("SGCN: uspace driver could not map physical memory.");
109	return -1;	109	return -1;
110	}	110	}
111		111
112	sram_buffer_offset = sysinfo_value("sram.buffer.offset");	112	sram_buffer_offset = sysinfo_value("sram.buffer.offset");
113		113
114	thread_id_t tid;	114	thread_id_t tid;
115	int rc;	115	int rc;
116		116
117	rc = thread_create(sgcn_thread_impl, NULL, "kbd_poll", &tid);	117	rc = thread_create(sgcn_thread_impl, NULL, "kbd_poll", &tid);
118	if (rc != 0) {	118	if (rc != 0) {
119	return rc;	119	return rc;
120	}	120	}
121		121
122	return 0;	122	return 0;
123	}	123	}
124		124
125	void kbd_port_yield(void)	125	void kbd_port_yield(void)
126	{	126	{
127	polling_disabled = true;	127	polling_disabled = true;
128	}	128	}
129		129
130	void kbd_port_reclaim(void)	130	void kbd_port_reclaim(void)
131	{	131	{
132	polling_disabled = false;	132	polling_disabled = false;
133	}	133	}
134		134
135	/**	135	/**
136	* Handler of the "key pressed" event. Reads codes of all the pressed keys from	136	* Handler of the "key pressed" event. Reads codes of all the pressed keys from
137	* the buffer.	137	* the buffer.
138	*/	138	*/
139	static void sgcn_key_pressed(void)	139	static void sgcn_key_pressed(void)
140	{	140	{
141	char c;	141	char c;
142		142
143	uint32_t begin = SGCN_BUFFER_HEADER->in_begin;	143	uint32_t begin = SGCN_BUFFER_HEADER->in_begin;
144	uint32_t end = SGCN_BUFFER_HEADER->in_end;	144	uint32_t end = SGCN_BUFFER_HEADER->in_end;
145	uint32_t size = end - begin;	145	uint32_t size = end - begin;
146		146
147	volatile char buf_ptr = (volatile char )	147	volatile char buf_ptr = (volatile char )
148	SGCN_BUFFER(char, SGCN_BUFFER_HEADER->in_rdptr);	148	SGCN_BUFFER(char, SGCN_BUFFER_HEADER->in_rdptr);
149	volatile uint32_t *in_wrptr_ptr = &(SGCN_BUFFER_HEADER->in_wrptr);	149	volatile uint32_t *in_wrptr_ptr = &(SGCN_BUFFER_HEADER->in_wrptr);
150	volatile uint32_t *in_rdptr_ptr = &(SGCN_BUFFER_HEADER->in_rdptr);	150	volatile uint32_t *in_rdptr_ptr = &(SGCN_BUFFER_HEADER->in_rdptr);
151		151
152	while (in_rdptr_ptr != in_wrptr_ptr) {	152	while (in_rdptr_ptr != in_wrptr_ptr) {
153	c = *buf_ptr;	153	c = *buf_ptr;
154	in_rdptr_ptr = (((in_rdptr_ptr) - begin + 1) % size) + begin;	154	in_rdptr_ptr = (((in_rdptr_ptr) - begin + 1) % size) + begin;
155	buf_ptr = (volatile char *)	155	buf_ptr = (volatile char *)
156	SGCN_BUFFER(char, SGCN_BUFFER_HEADER->in_rdptr);	156	SGCN_BUFFER(char, SGCN_BUFFER_HEADER->in_rdptr);
157	kbd_push_scancode(c);	157	kbd_push_scancode(c);
158	}	158	}
159	}	159	}
160		160
161	/**	161	/**
162	* Thread to poll SGCN for keypresses.	162	* Thread to poll SGCN for keypresses.
163	*/	163	*/
164	static void sgcn_thread_impl(void arg)	164	static void sgcn_thread_impl(void arg)
165	{	165	{
166	(void) arg;	166	(void) arg;
167		167
168	while (1) {	168	while (1) {
169	if (polling_disabled == false)	169	if (polling_disabled == false)
170	sgcn_key_pressed();	170	sgcn_key_pressed();
171	usleep(POLL_INTERVAL);	171	usleep(POLL_INTERVAL);
172	}	172	}
173	}	173	}
174		174
175	/** @}	175	/** @}
176	*/	176	*/
177		177

Subversion Repositories HelenOS

(root)/tags/0.4.1/uspace/srv/kbd/port/sgcn.c – Rev 4330 → 4687