SoftUART.c 4.71 KB
Newer Older
1
/*
2
3
             LUFA Library
     Copyright (C) Dean Camera, 2010.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
8
9
10
11
12
13
*/

/*
  Copyright 2010  David Prentice (david.prentice [at] farming [dot] uk)
  Copyright 2010  Peter Danneger
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)

14
  Permission to use, copy, modify, distribute, and sell this
15
  software and its documentation for any purpose is hereby granted
16
  without fee, provided that the above copyright notice appear in
17
  all copies and that both that the copyright notice and this
18
19
20
  permission notice and warranty disclaimer appear in supporting
  documentation, and that the name of the author not be used in
  advertising or publicity pertaining to distribution of the
21
22
23
24
25
26
27
28
29
30
31
32
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

33
34
35
36
37
38
/** \file
 *
 *  Software UART for both data transmission and reception. This
 *  code continuously monitors the ring buffers set up by the main
 *  project source file and reads/writes data as it becomes available.
 */
39

40
#include "SoftUART.h"
41

42
/** Total number of bits remaining to be sent in the current frame */
43
static uint8_t TX_BitsRemaining;
44

45
46
47
/** Temporary data variable to hold the byte being transmitted as it is shifted out */
static uint8_t TX_Data;

48
49
/** Total number of bits remaining to be received in the current frame */
static uint8_t RX_BitsRemaining;
50
51
52
53

/** Temporary data variable to hold the byte being received as it is shifted in */
static uint8_t RX_Data;

54
/** Initialises the software UART, ready for data transmission and reception into the global ring buffers. */
55
56
void SoftUART_Init(void)
{
57
	/* Set TX pin to output high, enable RX pull-up */
58
59
60
61
	STXPORT |= (1 << STX);
	STXDDR  |= (1 << STX);
	SRXPORT |= (1 << SRX);

62
	/* Enable INT0 for the detection of incoming start bits that signal the start of a byte */
63
64
65
	EICRA  = (1 << ISC01);
	EIMSK  = (1 << INT0);

66
67
68
69
	/* Set the transmission and reception timer compare values for the default baud rate */
	SoftUART_SetBaud(9600);

	/* Setup reception timer compare ISR */
70
	TIMSK2 = (1 << ICIE2);
71

72
	/* Setup transmission timer compare ISR and start the timer */
73
74
	TIMSK3 = (1 << ICIE3);
	TCCR3B = ((1 << CS30) | (1 << WGM33) | (1 << WGM32));
75
76
}

77
/** ISR to detect the start of a bit being sent to the software UART. */
78
ISR(INT0_vect, ISR_BLOCK)
79
{
80
81
	/* Reset the number of reception bits remaining counter */
	RX_BitsRemaining = 8;
82

83
	/* Reset the bit reception timer */
84
	TCNT2 = 0;
85
86
87
88
89
90

	/* Check to see that the pin is still low (prevents glitches from starting a frame reception) */
	if (!(SRXPIN & (1 << SRX)))
	{
		/* Disable start bit detection ISR while the next byte is received */
		EIMSK = 0;
91

92
		/* Start the reception timer */
93
		TCCR2B = ((1 << CS20) | (1 << WGM23) | (1 << WGM22));
94
	}
95
96
}

97
/** ISR to manage the reception of bits to the software UART. */
98
ISR(TIMER2_CAPT_vect, ISR_BLOCK)
99
{
100
101
	/* Cache the current RX pin value for later checking */
	uint8_t SRX_Cached = (SRXPIN & (1 << SRX));
102
103

	/* Check if reception has finished */
104
	if (RX_BitsRemaining)
105
	{
106
		/* Shift the current received bit mask to the next bit position */
107
108
109
110
111
112
		RX_Data >>= 1;
		RX_BitsRemaining--;

		/* Store next bit into the received data variable */
		if (SRX_Cached)
		  RX_Data |= (1 << 7);
113
114
115
	}
	else
	{
116
		/* Disable the reception timer as all data has now been received, re-enable start bit detection ISR */
117
		TCCR2B = 0;
118
119
		EIFR   = (1 << INTF0);
		EIMSK  = (1 << INT0);
120
121
122

		/* Reception complete, store the received byte if stop bit valid */
		if (SRX_Cached)
123
		  RingBuffer_Insert(&UARTtoUSB_Buffer, RX_Data);
124
125
126
	}
}

127
/** ISR to manage the transmission of bits via the software UART. */
128
ISR(TIMER3_CAPT_vect, ISR_BLOCK)
129
{
130
	/* Check if transmission has finished */
131
	if (TX_BitsRemaining)
132
	{
133
134
135
		/* Set the TX line to the value of the next bit in the byte to send */
		if (TX_Data & (1 << 0))
		  STXPORT &= ~(1 << STX);
136
		else
137
138
139
140
141
		  STXPORT |=  (1 << STX);

		/* Shift the transmission byte to move the next bit into position and decrement the bits remaining counter */
		TX_Data >>= 1;
		TX_BitsRemaining--;
142
	}
143
	else if (!(RX_BitsRemaining) && !(RingBuffer_IsEmpty(&USBtoUART_Buffer)))
144
	{
145
146
147
		/* Start bit - TX line low */
		STXPORT &= ~(1 << STX);

148
		/* Transmission complete, get the next byte to send (if available) */
149
		TX_Data          = ~RingBuffer_Remove(&USBtoUART_Buffer);
150
		TX_BitsRemaining = 9;
151
	}
152
}
153