Firmware 2main 8c

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.
01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Dulcimer: firmware/main.c File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>

<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<h1>firmware/main.c File Reference</h1>Main functions for USB-keyboard. <a
href="#_details">More...</a>
<p>
<code>#include <avr/io.h></code><br>
<code>#include <avr/interrupt.h></code><br>
<code>#include <avr/pgmspace.h></code><br>
<code>#include <avr/wdt.h></code><br>
<code>#include <util/delay.h></code><br>
<code>#include <string.h></code><br>
<code>#include <stdio.h></code><br>
<code>#include "usbdrv.h"</code><br>
<code>#include "<a class="el"
href="keycodes_8h-source.html">keycodes.h</a>"</code><br>
<p>
<a href="firmware_2main_8c-source.html">Go to the source code of this
file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td
class="memItemRight" valign="bottom"><a class="el"
href="structKey.html">Key</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This structure can be

used as a container for a single 'key'. <a
href="structKey.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td
href="firmware_2main_8c.html#43bafb28b29491ec7f871319b5a3b2f8">F_CPU</
a>   12000000L</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">we use a 12MHz crystal

<a href="#43bafb28b29491ec7f871319b5a3b2f8"></a><br></td></tr>
href="firmware_2main_8c.html#cbd3f71ae519660472d571c6991b45a7">PORTCOLUMNS</
a>   PORTB</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">port on which we read

the state of the columns <a
href="#cbd3f71ae519660472d571c6991b45a7"></a><br></td></tr>
href="firmware_2main_8c.html#82f68a695f5614aec3177e08d31ce7c4">PINCOLUMNS</
a>   PINB</td></tr>

href="#82f68a695f5614aec3177e08d31ce7c4"></a><br></td></tr>
href="firmware_2main_8c.html#3d5944be3fc9f1c33a00fe64c7b5dfa8">DDRCOLUMNS</
a>   DDRB</td></tr>

href="#3d5944be3fc9f1c33a00fe64c7b5dfa8"></a><br></td></tr>
href="firmware_2main_8c.html#2fb9b8c5860d621137c96ef9dd7a3176">PORTROWS1</
a>   PORTA</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">first port connected to

the matrix rows <a href="#2fb9b8c5860d621137c96ef9dd7a3176"></a><br></td></tr>
href="firmware_2main_8c.html#f69ec60ca24d74cd54bb3072429179ff">PINROWS1</
a>   PINA</td></tr>

the matrix rows <a href="#f69ec60ca24d74cd54bb3072429179ff"></a><br></td></tr>
href="firmware_2main_8c.html#054b4efed1b9fe12d1c162ab6eb3e12c">DDRROWS1</
a>   DDRA</td></tr>

the matrix rows <a href="#054b4efed1b9fe12d1c162ab6eb3e12c"></a><br></td></tr>
href="firmware_2main_8c.html#b930861e78c97023f7f919abab96d57b">PORTROWS2</
a>   PORTC</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">second port connected

to the matrix rows <a href="#b930861e78c97023f7f919abab96d57b"></a><br></td></tr>
href="firmware_2main_8c.html#f3d4ffa580843706c4cb46193942ef05">PINROWS2</
a>   PINC</td></tr>

to the matrix rows <a href="#f3d4ffa580843706c4cb46193942ef05"></a><br></td></tr>
href="firmware_2main_8c.html#257249c4c5913255d7f78061c5c789ce">DDRROWS2</
a>   DDRC</td></tr>

to the matrix rows <a href="#257249c4c5913255d7f78061c5c789ce"></a><br></td></tr>
href="firmware_2main_8c.html#1fc9fdc7dac7819e697429072f86d3de">PORTLEDS</
a>   PORTD</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">port on which the LEDs
are connected <a href="#1fc9fdc7dac7819e697429072f86d3de"></a><br></td></tr>
href="firmware_2main_8c.html#bbdadb5969e83f332dfb34029d143b98">PINLEDS</
a>   PIND</td></tr>

are connected <a href="#bbdadb5969e83f332dfb34029d143b98"></a><br></td></tr>
href="firmware_2main_8c.html#5e47233d3a02fa30d2ce44d60c058926">DDRLEDS</
a>   DDRD</td></tr>

are connected <a href="#5e47233d3a02fa30d2ce44d60c058926"></a><br></td></tr>
href="firmware_2main_8c.html#87ad17ac607cd11c6852ee2687580ac8">LEDSCROLL</
a>   PIND4</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">address of the scroll-

lock LED <a href="#87ad17ac607cd11c6852ee2687580ac8"></a><br></td></tr>
href="firmware_2main_8c.html#a1ebb1ee7d6ccd52c5ce53def057e544">LEDCAPS</
a>   PIND5</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">address of the caps-

lock LED <a href="#a1ebb1ee7d6ccd52c5ce53def057e544"></a><br></td></tr>
href="firmware_2main_8c.html#070b1a39c765aebc0d4a8353731224e6">LEDNUM</
a>   PIND6</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">address of the num-lock

LED <a href="#070b1a39c765aebc0d4a8353731224e6"></a><br></td></tr>
href="firmware_2main_8c.html#67297b400546c47d7a4d559747b55e9e">PORTJUMPERS</
a>   PORTD</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">port for additional

jumpers <a href="#67297b400546c47d7a4d559747b55e9e"></a><br></td></tr>
href="firmware_2main_8c.html#84ff5b11aa05f0a8e7fdd7e96f5c4176">PINJUMPERS</
a>   PIND</td></tr>

jumpers <a href="#84ff5b11aa05f0a8e7fdd7e96f5c4176"></a><br></td></tr>
href="firmware_2main_8c.html#3fdbed5110af4df594238e28a387feb4">DDRJUMPERS</
a>   DDRD</td></tr>

jumpers <a href="#3fdbed5110af4df594238e28a387feb4"></a><br></td></tr>
href="firmware_2main_8c.html#f70b2d39906342546418e16f30164bd5">JUMPER0</
a>   PD1</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">address for jumper 0

<a href="#f70b2d39906342546418e16f30164bd5"></a><br></td></tr>
href="firmware_2main_8c.html#6e6cf6eedfdcc5f2127642dcfda327b6">JUMPER1</
a>   PD3</td></tr>

<a href="#6e6cf6eedfdcc5f2127642dcfda327b6"></a><br></td></tr>
href="firmware_2main_8c.html#0ee74732a6d7f3c5fbe4df0b02d036b4">JUMPER2</
a>   PD7</td></tr>

<a href="#0ee74732a6d7f3c5fbe4df0b02d036b4"></a><br></td></tr>
href="firmware_2main_8c.html#77440c4104ae0a7368936ff87a3d3260">LED_NUM</
a>   0x01</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">num LED on a boot-

protocol keyboard <a href="#77440c4104ae0a7368936ff87a3d3260"></a><br></td></tr>
href="firmware_2main_8c.html#54eff1be759cb6a0ec1f522f985c9c58">LED_CAPS</
a>   0x02</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">caps LED on a boot-

protocol keyboard <a href="#54eff1be759cb6a0ec1f522f985c9c58"></a><br></td></tr>
href="firmware_2main_8c.html#4628cba683ac72e812db635372faf88a">LED_SCROLL</
a>   0x04</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">scroll LED on a boot-

protocol keyboard <a href="#4628cba683ac72e812db635372faf88a"></a><br></td></tr>
href="firmware_2main_8c.html#52baca6b68f2f753638465c69e691d43">LED_COMPOSE</
a>   0x08</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">compose LED on a boot-

protocol keyboard <a href="#52baca6b68f2f753638465c69e691d43"></a><br></td></tr>
href="firmware_2main_8c.html#12d4b576a70a2b7a3053adea8fd0a1f6">LED_KANA</
a>   0x10</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">kana LED on a boot-

protocol keyboard <a href="#12d4b576a70a2b7a3053adea8fd0a1f6"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">uint8_t </td><td
href="firmware_2main_8c.html#1a82bef73edf9d932a10315b0eaaa090">usbFunctionSetup</a>
(uint8_t data[8])</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is called

whenever we receive a setup request via USB. <a
href="#1a82bef73edf9d932a10315b0eaaa090"></a><br></td></tr>
href="firmware_2main_8c.html#149335bbad0138c9c707847dccd448d6">usbFunctionWrite</a>
(uchar *data, uchar len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The write function is

called when LEDs should be set. <a
href="#149335bbad0138c9c707847dccd448d6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td
href="firmware_2main_8c.html#bffc3119fb17bda876cd9ab7001a0723">usbSendReport</a>
(uint8_t mode, uint8_t key)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a single report to

the computer. <a href="#bffc3119fb17bda876cd9ab7001a0723"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el"
href="structKey.html">Key</a> </td><td class="memItemRight" valign="bottom"><a
class="el"
href="firmware_2main_8c.html#ca503c29786de18a51830b94b9dfabb6">charToKey</a> (char
character)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert an ASCII-

character to the corresponding key-code and modifier-code combination. <a
href="#ca503c29786de18a51830b94b9dfabb6"></a><br></td></tr>
href="firmware_2main_8c.html#543b8f51828d27738be1d4a9cb636dc5">sendKey</a> (<a
class="el" href="structKey.html">Key</a> keytosend)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a key to the

computer, followed by the release of all keys. <a
href="#543b8f51828d27738be1d4a9cb636dc5"></a><br></td></tr>
href="firmware_2main_8c.html#53e32b8c00eb3077d56eb67e69f0f55f">sendString</a> (char
*string)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a string to the

computer. <a href="#53e32b8c00eb3077d56eb67e69f0f55f"></a><br></td></tr>
href="firmware_2main_8c.html#573bbc8f1597b70f671b7849e39dc1f6">printMatrix</a>
(void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Print the current state

of the keyboard in a readable form. <a
href="#573bbc8f1597b70f671b7849e39dc1f6"></a><br></td></tr>
href="firmware_2main_8c.html#e57ab769295229435955aec63fe90a16">scankeys</a>
(void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Scan and debounce
keypresses. <a href="#e57ab769295229435955aec63fe90a16"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td
href="firmware_2main_8c.html#840291bc02cba5474a4cb46a9b9566fe">main</a>
(void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Main function,

containing the main loop that manages timer- and USB-functionality. <a
href="#840291bc02cba5474a4cb46a9b9566fe"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
href="firmware_2main_8c.html#f1cf86b4d81c490f25ab516aed0742f0">expectReport</a> =
0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">flag to indicate if we

expect an USB-report <a
href="#f1cf86b4d81c490f25ab516aed0742f0"></a><br></td></tr>
href="firmware_2main_8c.html#01788eba93b64b6aa561a3531b75053e">LEDstate</a> =
0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">current state of the

LEDs <a href="#01788eba93b64b6aa561a3531b75053e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">char
PROGMEM </td><td class="memItemRight" valign="bottom"><a class="el"
href="firmware_2main_8c.html#4c2feb67f6c3add002577ff194ad11d3">usbHidReportDescript
or</a> [USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">USB report descriptor

(length is defined in usbconfig.h). <a
href="#4c2feb67f6c3add002577ff194ad11d3"></a><br></td></tr>
href="firmware_2main_8c.html#4031bd527c85f293b4fca70e11dd337b">curmatrix</a>
[16]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">contains current state

of the keyboard <a href="#4031bd527c85f293b4fca70e11dd337b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const uint8_t
href="firmware_2main_8c.html#aeada6842a93dfcdd895fbdfb22b35c0">keymatrix</a> [16]
[8]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The keymatrix-array

contains positions of keys in the matrix. <a
href="#aeada6842a93dfcdd895fbdfb22b35c0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const uint8_t
href="firmware_2main_8c.html#9551cf4b116323bed1c59c814ba339d9">modmatrix</a> [16]
[8]</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The modmatrix-array

contains positions of the modifier-keys in the matrix. <a
href="#9551cf4b116323bed1c59c814ba339d9"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Main functions for USB-keyboard.
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd>Ronald Schaten <<a
href="mailto:ronald@schatenseite.de">ronald@schatenseite.de</a>> </dd></dl>
<dl class="version" compact><dt><b>Version:</b></dt><dd></dd></dl>
<dl class="rcs" compact><dt><b>Id</b></dt><dd>main.c,v 1.5 2008-07-12 21:05:24
rschaten Exp </dd></dl>
<p>
License: GNU GPL v2 (see License.txt)
<p>Definition in file <a class="el"
href="firmware_2main_8c-source.html">main.c</a>.</p>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="3d5944be3fc9f1c33a00fe64c7b5dfa8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DDRCOLUMNS   DDRB
</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
port on which we read the state of the columns
<p>
<p>Definition at line <a class="el" href="firmware_2main_8c-

source.html#l00225">225</a> of file <a class="el" href="firmware_2main_8c-
source.html">main.c</a>.</p>
</div>
</div><p>
<a class="anchor" name="3fdbed5110af4df594238e28a387feb4"></a>
<tr>
<td class="memname">#define DDRJUMPERS   DDRD
</td>
</tr>
</table>
</div>
<p>
port for additional jumpers
<p>

</div>
</div><p>
<a class="anchor" name="5e47233d3a02fa30d2ce44d60c058926"></a>
<tr>
<td class="memname">#define DDRLEDS   DDRD </td>
</tr>
</table>
</div>
<p>
port on which the LEDs are connected
<p>

</div>
</div><p>
<a class="anchor" name="054b4efed1b9fe12d1c162ab6eb3e12c"></a>
<tr>
<td class="memname">#define DDRROWS1   DDRA </td>
</tr>
</table>
</div>
<p>
first port connected to the matrix rows
<p>

<p>Referenced by <a class="el" href="firmware_2main_8c-

source.html#l00679">scankeys()</a>.</p>
</div>
</div><p>
<a class="anchor" name="257249c4c5913255d7f78061c5c789ce"></a>
<tr>
<td class="memname">#define DDRROWS2   DDRC </td>
</tr>
</table>
</div>
<p>
second port connected to the matrix rows
<p>


</div>
</div><p>
<a class="anchor" name="43bafb28b29491ec7f871319b5a3b2f8"></a>
<tr>
<td class="memname">#define F_CPU   12000000L
</td>
</tr>
</table>
</div>
<p>
we use a 12MHz crystal
<p>

</div>
</div><p>
<a class="anchor" name="f70b2d39906342546418e16f30164bd5"></a>
<tr>
<td class="memname">#define JUMPER0   PD1 </td>
</tr>
</table>
</div>
<p>
address for jumper 0
<p>

</div>
</div><p>
<a class="anchor" name="6e6cf6eedfdcc5f2127642dcfda327b6"></a>
<tr>
</tr>
</table>
</div>
<p>
<p>

</div>
</div><p>
<a class="anchor" name="0ee74732a6d7f3c5fbe4df0b02d036b4"></a>
<tr>
</tr>
</table>
</div>
<p>
<p>

</div>
</div><p>
<a class="anchor" name="54eff1be759cb6a0ec1f522f985c9c58"></a>
<tr>
<td class="memname">#define LED_CAPS   0x02 </td>
</tr>
</table>
</div>
<p>
caps LED on a boot-protocol keyboard
<p>


source.html#l00384">usbFunctionWrite()</a>.</p>
</div>
</div><p>
<a class="anchor" name="52baca6b68f2f753638465c69e691d43"></a>
<tr>
<td class="memname">#define LED_COMPOSE   0x08
</td>
</tr>
</table>
</div>
<p>
compose LED on a boot-protocol keyboard
<p>

</div>
</div><p>
<a class="anchor" name="12d4b576a70a2b7a3053adea8fd0a1f6"></a>
<tr>
<td class="memname">#define LED_KANA   0x10 </td>
</tr>
</table>
</div>
<p>
kana LED on a boot-protocol keyboard
<p>

</div>
</div><p>
<a class="anchor" name="77440c4104ae0a7368936ff87a3d3260"></a>
<tr>
<td class="memname">#define LED_NUM   0x01 </td>
</tr>
</table>
</div>
<p>
num LED on a boot-protocol keyboard
<p>


</div>
</div><p>
<a class="anchor" name="4628cba683ac72e812db635372faf88a"></a>
<tr>
<td class="memname">#define LED_SCROLL   0x04
</td>
</tr>
</table>
</div>
<p>
scroll LED on a boot-protocol keyboard
<p>


</div>
</div><p>
<a class="anchor" name="a1ebb1ee7d6ccd52c5ce53def057e544"></a>
<tr>
<td class="memname">#define LEDCAPS   PIND5 </td>
</tr>
</table>
</div>
<p>
address of the caps-lock LED
<p>


</div>
</div><p>
<a class="anchor" name="070b1a39c765aebc0d4a8353731224e6"></a>
<tr>
<td class="memname">#define LEDNUM   PIND6 </td>
</tr>
</table>
</div>
<p>
address of the num-lock LED
<p>


</div>
</div><p>
<a class="anchor" name="87ad17ac607cd11c6852ee2687580ac8"></a>
<tr>
<td class="memname">#define LEDSCROLL   PIND4
</td>
</tr>
</table>
</div>
<p>
address of the scroll-lock LED
<p>


</div>
</div><p>
<a class="anchor" name="82f68a695f5614aec3177e08d31ce7c4"></a>
<tr>
<td class="memname">#define PINCOLUMNS   PINB
</td>
</tr>
</table>
</div>
<p>
<p>


</div>
</div><p>
<a class="anchor" name="84ff5b11aa05f0a8e7fdd7e96f5c4176"></a>
<tr>
<td class="memname">#define PINJUMPERS   PIND
</td>
</tr>
</table>
</div>
<p>
<p>

</div>
</div><p>
<a class="anchor" name="bbdadb5969e83f332dfb34029d143b98"></a>
<tr>
<td class="memname">#define PINLEDS   PIND </td>
</tr>
</table>
</div>
<p>
<p>

</div>
</div><p>
<a class="anchor" name="f69ec60ca24d74cd54bb3072429179ff"></a>
<tr>
<td class="memname">#define PINROWS1   PINA </td>
</tr>
</table>
</div>
<p>
<p>

</div>
</div><p>
<a class="anchor" name="f3d4ffa580843706c4cb46193942ef05"></a>
<tr>
<td class="memname">#define PINROWS2   PINC </td>
</tr>
</table>
</div>
<p>
<p>

</div>
</div><p>
<a class="anchor" name="cbd3f71ae519660472d571c6991b45a7"></a>
<tr>
<td class="memname">#define PORTCOLUMNS   PORTB
</td>
</tr>
</table>
</div>
<p>
<p>

</div>
</div><p>
<a class="anchor" name="67297b400546c47d7a4d559747b55e9e"></a>
<tr>
<td class="memname">#define PORTJUMPERS   PORTD
</td>
</tr>
</table>
</div>
<p>
<p>

</div>
</div><p>
<a class="anchor" name="1fc9fdc7dac7819e697429072f86d3de"></a>
<tr>
<td class="memname">#define PORTLEDS   PORTD
</td>
</tr>
</table>
</div>
<p>
<p>


</div>
</div><p>
<a class="anchor" name="2fb9b8c5860d621137c96ef9dd7a3176"></a>
<tr>
<td class="memname">#define PORTROWS1   PORTA
</td>
</tr>
</table>
</div>
<p>
<p>


</div>
</div><p>
<a class="anchor" name="b930861e78c97023f7f919abab96d57b"></a>
<tr>
<td class="memname">#define PORTROWS2   PORTC
</td>
</tr>
</table>
</div>
<p>
<p>

</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="ca503c29786de18a51830b94b9dfabb6"></a>
<tr>
<td class="memname"><a class="el" href="structKey.html">Key</a> charToKey
</td>
<td>(</td>
<td class="paramtype">char </td>
<td class="paramname"> <em>character</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<p>
Convert an ASCII-character to the corresponding key-code and modifier-code
combination.
<p>
character ASCII-character to convert <dl class="return"
compact><dt><b>Returns:</b></dt><dd>structure containing the combination </dd></dl>

<p>References <a class="el"

href="firmware_2main_8c-source.html#l00484">Key::key</a>, <a class="el"
href="keycodes_8h-source.html#l00071">KEY_0</a>, <a class="el" href="keycodes_8h-
source.html#l00062">KEY_1</a>, <a class="el" href="keycodes_8h-
source.html#l00084">KEY_apostroph</a>, <a class="el" href="keycodes_8h-
source.html#l00081">KEY_backslash</a>, <a class="el" href="keycodes_8h-
source.html#l00086">KEY_comma</a>, <a class="el" href="keycodes_8h-
source.html#l00087">KEY_dot</a>, <a class="el" href="keycodes_8h-
source.html#l00078">KEY_equals</a>, <a class="el" href="keycodes_8h-
source.html#l00085">KEY_grave</a>, <a class="el" href="keycodes_8h-
source.html#l00082">KEY_hash</a>, <a class="el" href="keycodes_8h-
source.html#l00079">KEY_lbracket</a>, <a class="el" href="keycodes_8h-
source.html#l00077">KEY_minus</a>, <a class="el" href="keycodes_8h-
source.html#l00080">KEY_rbracket</a>, <a class="el" href="keycodes_8h-
source.html#l00032">KEY_Reserved</a>, <a class="el" href="keycodes_8h-
source.html#l00083">KEY_semicolon</a>, <a class="el" href="keycodes_8h-
source.html#l00088">KEY_slash</a>, <a class="el" href="keycodes_8h-
source.html#l00076">KEY_Spacebar</a>, <a class="el" href="keycodes_8h-
source.html#l00019">MOD_NONE</a>, <a class="el" href="keycodes_8h-
source.html#l00021">MOD_SHIFT_LEFT</a>, and <a class="el" href="firmware_2main_8c-
source.html#l00483">Key::mode</a>.</p>

source.html#l00631">sendString()</a>.</p>
</div>
</div><p>
<a class="anchor" name="840291bc02cba5474a4cb46a9b9566fe"></a>
<tr>
<td class="memname">int main </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"> </td>
<td> ) </td>
</tr>
</table>
</div>
<p>
Main function, containing the main loop that manages timer- and USB-functionality.
<p>
/return the obligatory integer that nobody cares about...
<p>References <a class="el" href="firmware_2main_8c-

</div>
</div><p>
<a class="anchor" name="573bbc8f1597b70f671b7849e39dc1f6"></a>
<tr>
<td class="memname">void printMatrix </td>
<td>(</td>
<td> ) </td>
</tr>
</table>
</div>
<p>
Print the current state of the keyboard in a readable form.
<p>
This function is used for debug-purposes only.

source.html#l00424">curmatrix</a>, and <a class="el" href="firmware_2main_8c-
</div>
</div><p>
<a class="anchor" name="e57ab769295229435955aec63fe90a16"></a>
<tr>
<td class="memname">uint8_t scankeys </td>
<td>(</td>
<td> ) </td>
</tr>
</table>
</div>
<p>
Scan and debounce keypresses.
<p>
This is the main worker function for normal keyboard operation, the code contains
lot of comments. Basically, it first scans the keyboard state. If a change is
detected, it initializes a counter that is decreased each time this function is
called. If the counter reaches 1, that means that the same scan result has been
scanned ten times in a row, so we can be pretty sure that the keys are in a certain
state (as in: not bouncing). Then, the codes for keys and modifiers are searched
from the two arrays, the USB-message to send the state is prepared. The return
value of this function indicates if the message has to be sent. <dl class="return"
compact><dt><b>Returns:</b></dt><dd>flag to indicate whether something has changed
</dd></dl>


source.html#l00424">curmatrix</a>, <a class="el" href="firmware_2main_8c-
source.html#l00228">DDRROWS1</a>, <a class="el" href="firmware_2main_8c-
source.html#l00231">DDRROWS2</a>, <a class="el" href="keycodes_8h-
source.html#l00033">KEY_ErrorRollOver</a>, <a class="el" href="keycodes_8h-
source.html#l00032">KEY_Reserved</a>, <a class="el" href="firmware_2main_8c-
source.html#l00433">keymatrix</a>, <a class="el" href="keycodes_8h-
source.html#l00019">MOD_NONE</a>, <a class="el" href="firmware_2main_8c-
source.html#l00458">modmatrix</a>, <a class="el" href="firmware_2main_8c-
source.html#l00224">PINCOLUMNS</a>, <a class="el" href="firmware_2main_8c-
source.html#l00226">PORTROWS1</a>, and <a class="el" href="firmware_2main_8c-
source.html#l00229">PORTROWS2</a>.</p>

source.html#l00755">main()</a>.</p>
</div>
</div><p>
<a class="anchor" name="543b8f51828d27738be1d4a9cb636dc5"></a>
<tr>
<td class="memname">void sendKey </td>
<td>(</td>
<td class="paramtype"><a class="el"
href="structKey.html">Key</a> </td>
<td class="paramname"> <em>keytosend</em> </td>
<td> ) </td>
</tr>
</table>
</div>
<p>
Send a key to the computer, followed by the release of all keys.
<p>
This can be used repetitively to send a string. <dl
compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>keytosend</em> </td><td>key
structure to send </td></tr>
</table>
</dl>

<p>References <a class="el"

href="firmware_2main_8c-source.html#l00484">Key::key</a>, <a class="el"
href="firmware_2main_8c-source.html#l00483">Key::mode</a>, and <a class="el"
href="firmware_2main_8c-source.html#l00413">usbSendReport()</a>.</p>

</div>
</div><p>
<a class="anchor" name="53e32b8c00eb3077d56eb67e69f0f55f"></a>
<tr>
<td class="memname">void sendString </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>string</em> </td>
<td> ) </td>
</tr>
</table>
</div>
<p>
Send a string to the computer.
<p>
This function converts each character of an ASCII-string to a key-structure and
uses <a class="el" href="firmware_2main_8c.html#543b8f51828d27738be1d4a9cb636dc5"
title="Send a key to the computer, followed by the release of all
keys.">sendKey()</a> to send it. <dl compact><dt><b>Parameters:</b></dt><dd>
<tr><td valign="top"></td><td valign="top"><em>string</em> </td><td>string
to send </td></tr>
</table>
</dl>


source.html#l00493">charToKey()</a>, and <a class="el" href="firmware_2main_8c-
source.html#l00621">sendKey()</a>.</p>

source.html#l00642">printMatrix()</a>.</p>
</div>
</div><p>
<a class="anchor" name="1a82bef73edf9d932a10315b0eaaa090"></a>
<tr>
<td class="memname">uint8_t usbFunctionSetup </td>
<td>(</td>
<td class="paramtype">uint8_t </td>
<td class="paramname"> <em>data</em>[8] </td>
<td> ) </td>
</tr>
</table>
</div>
<p>
This function is called whenever we receive a setup request via USB.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<tr><td valign="top"></td><td valign="top"><em>data[8]</em> </td><td>eight
bytes of data we received </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>number of bytes to use, or
0xff if <a class="el"
href="bootloader_2main_8c.html#92f69288e90801df366cde5a838a818f">usbFunctionWrite()
</a> should be called </dd></dl>


source.html#l00288">expectReport</a>.</p>
</div>
</div><p>
<a class="anchor" name="149335bbad0138c9c707847dccd448d6"></a>
<tr>
<td class="memname">uint8_t usbFunctionWrite </td>
<td>(</td>
<td class="paramtype">uchar * </td>
<td class="paramname"> <em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uchar </td>
<td class="paramname"> <em>len</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<p>
The write function is called when LEDs should be set.
<p>
Normally, we get only one byte that contains info about the LED states. <dl
compact><dt><b>Parameters:</b></dt><dd>
<tr><td valign="top"></td><td valign="top"><em>data</em> </td><td>pointer
to received data </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>number ob
bytes received </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>0x01 </dd></dl>

source.html#l00288">expectReport</a>, <a class="el" href="firmware_2main_8c-
source.html#l00291">LED_CAPS</a>, <a class="el" href="firmware_2main_8c-
source.html#l00290">LED_NUM</a>, <a class="el" href="firmware_2main_8c-
source.html#l00292">LED_SCROLL</a>, <a class="el" href="firmware_2main_8c-
source.html#l00237">LEDCAPS</a>, <a class="el" href="firmware_2main_8c-
source.html#l00238">LEDNUM</a>, <a class="el" href="firmware_2main_8c-
source.html#l00236">LEDSCROLL</a>, <a class="el" href="firmware_2main_8c-
source.html#l00295">LEDstate</a>, and <a class="el" href="firmware_2main_8c-
source.html#l00233">PORTLEDS</a>.</p>
</div>
</div><p>
<a class="anchor" name="bffc3119fb17bda876cd9ab7001a0723"></a>
<tr>
<td class="memname">void usbSendReport </td>
<td>(</td>
<td class="paramname"> <em>mode</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramname"> <em>key</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<p>
Send a single report to the computer.
<p>
This function is not used during normal typing, it is only used to send non-pressed
keys to simulate input. <dl compact><dt><b>Parameters:</b></dt><dd>
<tr><td valign="top"></td><td
valign="top"><em>mode</em> </td><td>modifier-byte </td></tr>
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>key-code
</td></tr>
</table>
</dl>


source.html#l00621">sendKey()</a>.</p>
</div>
</div><p>
<hr><h2>Variable Documentation</h2>
<a class="anchor" name="4031bd527c85f293b4fca70e11dd337b"></a>
<tr>
<td class="memname">uint8_t <a class="el"
href="firmware_2main_8c.html#4031bd527c85f293b4fca70e11dd337b">curmatrix</a>[16]
</td>
</tr>
</table>
</div>
<p>
contains current state of the keyboard
<p>


source.html#l00642">printMatrix()</a>, and <a class="el" href="firmware_2main_8c-
</div>
</div><p>
<a class="anchor" name="f1cf86b4d81c490f25ab516aed0742f0"></a>
<tr>
href="firmware_2main_8c.html#f1cf86b4d81c490f25ab516aed0742f0">expectReport</a> = 0
</td>
</tr>
</table>
</div>
<p>
flag to indicate if we expect an USB-report
<p>

source.html#l00343">usbFunctionSetup()</a>, and <a class="el"
href="firmware_2main_8c-source.html#l00384">usbFunctionWrite()</a>.</p>
</div>
</div><p>
<a class="anchor" name="aeada6842a93dfcdd895fbdfb22b35c0"></a>
<tr>
href="firmware_2main_8c.html#01788eba93b64b6aa561a3531b75053e">LEDstate</a> = 0
</td>
</tr>
</table>
</div>
<p>
current state of the LEDs
<p>


</div>
</div><p>
<a class="anchor" name="9551cf4b116323bed1c59c814ba339d9"></a>
<tr>
<td class="memname">char PROGMEM <a class="el"
href="firmware_2main_8c.html#4c2feb67f6c3add002577ff194ad11d3">usbHidReportDescript
or</a>[USB_CFG_HID_REPORT_DESCRIPTOR_LENGTH] </td>
</tr>
</table>
</div>
<p>
USB report descriptor (length is defined in usbconfig.h).
<p>
The report descriptor has been created with usb.org's "HID Descriptor Tool" which
can be downloaded from <a
href="http://www.usb.org/developers/hidpage/">http://www.usb.org/developers/
hidpage/</a> (it's an .exe, but it even runs under Wine).
</div>
</div><p>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Jul 12
22:27:15 2008 for Dulcimer by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.4
</small></address>
</body>
</html>

Firmware 2main 8c

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Firmware 2main 8c

Uploaded by

Copyright:

Available Formats

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This structure can be

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">we use a 12MHz crystal

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">port on which we read

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">port on which we read

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">port on which we read

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">first port connected to

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">first port connected to

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">first port connected to

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">second port connected

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">second port connected

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">second port connected

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">port on which the LEDs

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">port on which the LEDs

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">address of the scroll-

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">address of the caps-

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">address of the num-lock

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">port for additional

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">port for additional

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">port for additional

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">address for jumper 0

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">address for jumper 1

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">address for jumper 2

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">num LED on a boot-

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">caps LED on a boot-

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">scroll LED on a boot-

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">compose LED on a boot-

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">kana LED on a boot-

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This function is called

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The write function is

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a single report to

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Convert an ASCII-

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a key to the

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Send a string to the

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Print the current state

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Main function,

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">flag to indicate if we

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">current state of the

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">USB report descriptor

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">contains current state

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The keymatrix-array

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">The modmatrix-array

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Referenced by <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Referenced by <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Referenced by <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Referenced by <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Referenced by <a class="el" href="firmware_2main_8c-

<p>Definition at line <a class="el" href="firmware_2main_8c-

<p>Referenced by <a class="el" href="firmware_2main_8c-

<tr><td class="mdescLeft"> </td><td class="mdescRight">This structure can be

<tr><td class="mdescLeft"> </td><td class="mdescRight">we use a 12MHz crystal

<tr><td class="mdescLeft"> </td><td class="mdescRight">port on which we read

<tr><td class="mdescLeft"> </td><td class="mdescRight">port on which we read

<tr><td class="mdescLeft"> </td><td class="mdescRight">port on which we read

<tr><td class="mdescLeft"> </td><td class="mdescRight">first port connected to

<tr><td class="mdescLeft"> </td><td class="mdescRight">first port connected to

<tr><td class="mdescLeft"> </td><td class="mdescRight">first port connected to

<tr><td class="mdescLeft"> </td><td class="mdescRight">second port connected

<tr><td class="mdescLeft"> </td><td class="mdescRight">second port connected

<tr><td class="mdescLeft"> </td><td class="mdescRight">second port connected

<tr><td class="mdescLeft"> </td><td class="mdescRight">port on which the LEDs

<tr><td class="mdescLeft"> </td><td class="mdescRight">port on which the LEDs

<tr><td class="mdescLeft"> </td><td class="mdescRight">address of the scroll-

<tr><td class="mdescLeft"> </td><td class="mdescRight">address of the caps-

<tr><td class="mdescLeft"> </td><td class="mdescRight">address of the num-lock

<tr><td class="mdescLeft"> </td><td class="mdescRight">port for additional

<tr><td class="mdescLeft"> </td><td class="mdescRight">port for additional

<tr><td class="mdescLeft"> </td><td class="mdescRight">port for additional

<tr><td class="mdescLeft"> </td><td class="mdescRight">address for jumper 0

<tr><td class="mdescLeft"> </td><td class="mdescRight">address for jumper 1

<tr><td class="mdescLeft"> </td><td class="mdescRight">address for jumper 2

<tr><td class="mdescLeft"> </td><td class="mdescRight">num LED on a boot-

<tr><td class="mdescLeft"> </td><td class="mdescRight">caps LED on a boot-

<tr><td class="mdescLeft"> </td><td class="mdescRight">scroll LED on a boot-

<tr><td class="mdescLeft"> </td><td class="mdescRight">compose LED on a boot-

<tr><td class="mdescLeft"> </td><td class="mdescRight">kana LED on a boot-

<tr><td class="mdescLeft"> </td><td class="mdescRight">This function is called

<tr><td class="mdescLeft"> </td><td class="mdescRight">The write function is

<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a single report to

<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert an ASCII-

<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a key to the

<tr><td class="mdescLeft"> </td><td class="mdescRight">Send a string to the

<tr><td class="mdescLeft"> </td><td class="mdescRight">Print the current state

<tr><td class="mdescLeft"> </td><td class="mdescRight">Main function,

<tr><td class="mdescLeft"> </td><td class="mdescRight">flag to indicate if we

<tr><td class="mdescLeft"> </td><td class="mdescRight">current state of the

<tr><td class="mdescLeft"> </td><td class="mdescRight">USB report descriptor

<tr><td class="mdescLeft"> </td><td class="mdescRight">contains current state

<tr><td class="mdescLeft"> </td><td class="mdescRight">The keymatrix-array

<tr><td class="mdescLeft"> </td><td class="mdescRight">The modmatrix-array