annotate main.c @ 25:c2ef3daf39e1

Cleaning up main.c - main.c is now mostly complete - Required fixes to matrix.c (some are temporary)
author Jacob Alexander <haata@users.sf.net>
date Fri, 30 Sep 2011 01:30:34 -0700
parents 2d65da455ef3
children c06a5ebb4fca
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
1 /* Copyright (C) 2011 by Jacob Alexander
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
2 *
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
4 * of this software and associated documentation files (the "Software"), to deal
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
5 * in the Software without restriction, including without limitation the rights
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
7 * copies of the Software, and to permit persons to whom the Software is
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
8 * furnished to do so, subject to the following conditions:
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
9 *
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
10 * The above copyright notice and this permission notice shall be included in
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
11 * all copies or substantial portions of the Software.
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
12 *
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
19 * THE SOFTWARE.
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
20 */
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
21
24
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
22 // ----- Includes -----
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
23
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
24 // AVR Includes
0
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
25 #include <avr/io.h>
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
26 #include <avr/interrupt.h>
24
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
27
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
28 // Project Includes
25
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
29 #include <macro.h>
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
30 #include <scan_loop.h>
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
31 #include <usb_com.h>
2
c3b2eaa4a89d Significant progress made.
Jacob Alexander <triplehaata@gmail.com>
parents: 1
diff changeset
32
25
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
33 #include <led.h>
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
34 #include <print.h>
0
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
35
6
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
36
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
37
24
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
38 // ----- Defines -----
6
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
39
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
40 // Verified Keypress Defines
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
41 #define USB_TRANSFER_DIVIDER 10 // 1024 == 1 Send of keypresses per second, 1 == 1 Send of keypresses per ~1 millisecond
1
0f88e9aad77a Initial macro line filler design for multiple keyboards matrices.
Jacob Alexander <triplehaata@gmail.com>
parents: 0
diff changeset
42
24
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
43
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
44
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
45 // ----- Macros -----
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
46 #define CPU_PRESCALE(n) (CLKPR = 0x80, CLKPR = (n))
2
c3b2eaa4a89d Significant progress made.
Jacob Alexander <triplehaata@gmail.com>
parents: 1
diff changeset
47
c3b2eaa4a89d Significant progress made.
Jacob Alexander <triplehaata@gmail.com>
parents: 1
diff changeset
48
c3b2eaa4a89d Significant progress made.
Jacob Alexander <triplehaata@gmail.com>
parents: 1
diff changeset
49
24
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
50 // ----- Variables -----
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
51
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
52 // Timer Interrupt for flagging a send of the sampled key detection data to the USB host
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
53 uint16_t sendKeypressCounter = 0;
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
54
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
55 // Flag generated by the timer interrupt
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
56 volatile uint8_t sendKeypresses = 0;
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
57
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
58
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
59
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
60 // ----- Functions -----
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
61
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
62 // Initial Pin Setup, make sure they are sane
6
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
63 inline void pinSetup(void)
2
c3b2eaa4a89d Significant progress made.
Jacob Alexander <triplehaata@gmail.com>
parents: 1
diff changeset
64 {
c3b2eaa4a89d Significant progress made.
Jacob Alexander <triplehaata@gmail.com>
parents: 1
diff changeset
65 // For each pin, 0=input, 1=output
c3b2eaa4a89d Significant progress made.
Jacob Alexander <triplehaata@gmail.com>
parents: 1
diff changeset
66 DDRA = 0x00;
5
a8be29294c26 Updating for the latest pinout
Jacob Alexander <triplehaata@gmail.com>
parents: 4
diff changeset
67 DDRB = 0x00;
a8be29294c26 Updating for the latest pinout
Jacob Alexander <triplehaata@gmail.com>
parents: 4
diff changeset
68 DDRC = 0x00;
24
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
69 DDRD = 0x00;
16
f74b797ac060 Parts of the upcoming rewrite
Jacob Alexander <triplehaata@gmail.com>
parents: 15
diff changeset
70 DDRE = 0x00;
5
a8be29294c26 Updating for the latest pinout
Jacob Alexander <triplehaata@gmail.com>
parents: 4
diff changeset
71 DDRF = 0x00;
2
c3b2eaa4a89d Significant progress made.
Jacob Alexander <triplehaata@gmail.com>
parents: 1
diff changeset
72
6
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
73
2
c3b2eaa4a89d Significant progress made.
Jacob Alexander <triplehaata@gmail.com>
parents: 1
diff changeset
74 // Setting pins to either high or pull-up resistor
16
f74b797ac060 Parts of the upcoming rewrite
Jacob Alexander <triplehaata@gmail.com>
parents: 15
diff changeset
75 PORTA = 0x00;
f74b797ac060 Parts of the upcoming rewrite
Jacob Alexander <triplehaata@gmail.com>
parents: 15
diff changeset
76 PORTB = 0x00;
f74b797ac060 Parts of the upcoming rewrite
Jacob Alexander <triplehaata@gmail.com>
parents: 15
diff changeset
77 PORTC = 0x00;
24
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
78 PORTD = 0x00;
16
f74b797ac060 Parts of the upcoming rewrite
Jacob Alexander <triplehaata@gmail.com>
parents: 15
diff changeset
79 PORTE = 0x00;
f74b797ac060 Parts of the upcoming rewrite
Jacob Alexander <triplehaata@gmail.com>
parents: 15
diff changeset
80 PORTF = 0x00;
2
c3b2eaa4a89d Significant progress made.
Jacob Alexander <triplehaata@gmail.com>
parents: 1
diff changeset
81 }
7
18e424630cbd Adding basic per line keypad detection
Jacob Alexander <haata@users.sf.net>
parents: 6
diff changeset
82
24
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
83 int main(void)
0
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
84 {
6
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
85 // Setup with 16 MHz clock
0
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
86 CPU_PRESCALE( 0 );
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
87
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
88 // Configuring Pins
2
c3b2eaa4a89d Significant progress made.
Jacob Alexander <triplehaata@gmail.com>
parents: 1
diff changeset
89 pinSetup();
25
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
90 init_errorLED();
0
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
91
24
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
92 // Setup USB Module
2d65da455ef3 Formalizing code module structure and inheritance (Large Commit)
Jacob Alexander <triplehaata@gmail.com>
parents: 18
diff changeset
93 usb_setup();
0
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
94
6
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
95 // Setup ISR Timer for flagging a kepress send to USB
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
96 // Set to 256 * 1024 (8 bit timer with Clock/1024 prescalar) timer
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
97 TCCR0A = 0x00;
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
98 TCCR0B = 0x03;
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
99 TIMSK0 = (1 << TOIE0);
4
b97797936037 Redefining pinouts and adding key sending code.
Jacob Alexander <triplehaata@gmail.com>
parents: 3
diff changeset
100
0
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
101 // Main Detection Loop
25
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
102 uint8_t ledTimer = 15; // Enable LED for a short time
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
103 while ( 1 )
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
104 {
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
105 while ( 1 )
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
106 {
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
107 // Acquire Key Indices
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
108 scan_loop();
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
109
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
110 // Send keypresses over USB if the ISR has signalled that it's time
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
111 if ( !sendKeypresses )
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
112 continue;
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
113
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
114 // Run Macros over Key Indices and convert to USB Keys
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
115 process_macros();
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
116
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
117 // Send USB Data
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
118 usb_send();
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
119
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
120 // Clear sendKeypresses Flag
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
121 sendKeypresses = 0;
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
122
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
123 // Indicate Error, if valid
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
124 errorLED( ledTimer );
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
125 }
16
f74b797ac060 Parts of the upcoming rewrite
Jacob Alexander <triplehaata@gmail.com>
parents: 15
diff changeset
126
f74b797ac060 Parts of the upcoming rewrite
Jacob Alexander <triplehaata@gmail.com>
parents: 15
diff changeset
127 // Loop should never get here (indicate error)
25
c2ef3daf39e1 Cleaning up main.c
Jacob Alexander <haata@users.sf.net>
parents: 24
diff changeset
128 ledTimer = 255;
16
f74b797ac060 Parts of the upcoming rewrite
Jacob Alexander <triplehaata@gmail.com>
parents: 15
diff changeset
129
17
85bc68be98df Code re-factor now compiles.
Jacob Alexander <triplehaata@gmail.com>
parents: 16
diff changeset
130 // HID Debug Error message
85bc68be98df Code re-factor now compiles.
Jacob Alexander <triplehaata@gmail.com>
parents: 16
diff changeset
131 erro_print("Detection loop error, this is very bad...bug report!");
16
f74b797ac060 Parts of the upcoming rewrite
Jacob Alexander <triplehaata@gmail.com>
parents: 15
diff changeset
132 }
f74b797ac060 Parts of the upcoming rewrite
Jacob Alexander <triplehaata@gmail.com>
parents: 15
diff changeset
133 }
0
43dfb6e4e697 Initial Commit
Jacob Alexander <triplehaata@gmail.com>
parents:
diff changeset
134
6
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
135 ISR( TIMER0_OVF_vect )
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
136 {
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
137 sendKeypressCounter++;
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
138 if ( sendKeypressCounter > USB_TRANSFER_DIVIDER ) {
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
139 sendKeypressCounter = 0;
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
140 sendKeypresses = 1;
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
141 }
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
142 }
9df636be6feb Keyboard functionally working with very very good debouncing.
Jacob Alexander <triplehaata@gmail.com>
parents: 5
diff changeset
143