File: printfUART.h

package info (click to toggle)
tinyos 2.1.2%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch
  • size: 47,476 kB
  • ctags: 36,607
  • sloc: ansic: 63,646; cpp: 14,974; java: 10,358; python: 5,215; makefile: 1,724; sh: 902; asm: 597; xml: 392; perl: 74; awk: 46
file content (378 lines) | stat: -rw-r--r-- 10,292 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
/*
 * Copyright (c) 2005
 *	The President and Fellows of Harvard College.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE UNIVERSITY AND CONTRIBUTORS ``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 UNIVERSITY OR CONTRIBUTORS 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.
 */

/* 
 * Writes printf like output to the UART.  
 * This works only on the AVR and MSP430 Microcontrollers!
 * <p>
 * Note: For AVR we explicitly place the print statements in ROM; for
 * MSP430 this is done by default!  For AVR, if we don't place it
 * explicitely in ROM, the statements will go in RAM, which will
 * quickly cause a descent size program to run out of RAM.  By default
 * it doesn't disable the interupts; disabling the interupts when
 * writing to the UART, slows down/makes the mote quite unresponsive,
 * and can lead to problems!  If you wish to disable all printfs to
 * the UART, then comment the flag: <code>PRINTFUART_ENABLED</code>.

 * <p> <pre>
 * How to use:
 *   // (1) Call printfUART_init() from your initialization function 
 *   //     to initialize the UART
 *   printfUART_init();
 *   // (2) Set your UART client to the correct baud rate.  Look at 
 *   //     the comments in printfUART_init(), to figure out what 
 *   //     baud to use for your particular mote
 *
 *   // (3) Send printf statements like this:
 *   printfUART("Hello World, we are in year= %i\n", 2004);
 *
 * Examples and caveats:
 *   // (1) - If no parameters are passed, then the second quotes 
 *            are required because of how the macro is defined
 *   printfUART("Timer fired\n", ""); 
 *   // (2) - Must use curly braces in single section statements
 *   if (x < 3)
 *       {printfUART("The value of x is %i\n", x);}
 *   // (3) - Otherwise it more or less works like regular printf
 *   printfUART("\nThe value of x=%i, and y=%i\n", x, y); 
 * </pre>
 * <pre>URL: http://www.eecs.harvard.edu/~konrad/projects/motetrack</pre>
 * @author Konrad Lorincz
 * @version 2.0, January 5, 2005
 */
#ifndef PRINTFUART_H
#define PRINTFUART_H
#include <stdarg.h>
//#include <stdio.h>

// Comment out the line below to DISABLE printf statements. 
// This should be handled at the application Makefile
//#define PRINTFUART_ENABLED

// STE
// found: http://mansos.net/svn/mansos/mos/hpl/chips/msp430/msp430_timers.h
#define SSEL_0        0x00
#define SSEL_1        0x10
#define SSEL_2        0x20
#define SSEL_3        0x30

#define SSEL_ACLK     SSEL_1
#define SSEL_SMCLK    SSEL_2
// End STE


// -------------------------------------------------------------------
#ifdef PRINTFUART_ENABLED
    #define DEBUGBUF_SIZE 256
    char debugbuf[DEBUGBUF_SIZE];
    char debugbufROMtoRAM[DEBUGBUF_SIZE];

    #if defined(PLATFORM_MICAZ) || defined(PLATFORM_MICA2) || defined(PLATFORM_MICA2DOT)
        #define printfUART(__format, __args...) {                  \
            static const char strROM[] PROGMEM = __format;         \
            strcpy_P((char*) &debugbufROMtoRAM, (PGM_P) &strROM);  \
            sprintf(debugbuf, debugbufROMtoRAM, __args);           \
            writedebug();                                          \
        }   
    #else  // assume MSP430 architecture (e.g. TelosA, TelosB, etc.)
        #define printfUART(__format, __args...) {      \
            sprintf(debugbuf, __format, __args);       \
            writedebug();                              \
        }   
    #endif
#else
    #define printfUART(__format, __args...)
    void printfUART_init() {}
#endif

#define NOprintfUART(__format, __args...)


/** Used for terminating the program from a non-nesc file. Calling <code>exit(1)</code> 
 *  from a non-nesc file doesn't terminate the program immeditely
 */
static int EXIT_PROGRAM = 0;  



// -------------------------------------------------------------------
#ifdef PRINTFUART_ENABLED

/**
 * Initialize the UART port.  Call this from your startup routine.
 */
#define printfUART_init() {atomic printfUART_init_private();}
void printfUART_init_private()
{
#if defined(PLATFORM_MICAZ) || defined(PLATFORM_MICA2)
	uint8_t dummy = 0;
	// 56K baud
	UBRR0H = 0;
	UBRR0L = 15;							//set baud rate
	UCSR0A = (1<<U2X);						// Set UART double speed
	UCSR0C = ((1 << UCSZ1) | (1 << UCSZ0));	// Set frame format: 8 data-bits, 1 stop-bit
	dummy = UDR0;
	UCSR0B = (1 << TXEN);					// Enable uart reciever and transmitter
/*
	outp(0,UBRR0H);
	outp(15, UBRR0L);                              //set baud rate
	outp((1<<U2X),UCSR0A);                         // Set UART double speed
	outp(((1 << UCSZ1) | (1 << UCSZ0)) , UCSR0C);  // Set frame format: 8 data-bits, 1 stop-bit
	inp(UDR0);
	outp((1 << TXEN) ,UCSR0B);   // Enable uart reciever and transmitter
*/
#else
	#if defined(PLATFORM_MICA2DOT)  
		// 19.2K baud
		outp(0,UBRR0H);            // Set baudrate to 19.2 KBps
		outp(12, UBRR0L);
		outp(0,UCSR0A);            // Disable U2X and MPCM
		outp(((1 << UCSZ1) | (1 << UCSZ0)) , UCSR0C);
		inp(UDR0);
		outp((1 << TXEN) ,UCSR0B);

	#else  // assume TelosA, TelosB, etc.
		//9.6K baud
		uint16_t l_br = 0;
		uint8_t l_mctl = 0;
		uint8_t l_ssel = 0;

		TOSH_SEL_UTXD1_MODFUNC();
		TOSH_SEL_URXD1_MODFUNC();

		UCTL1 = SWRST;  
		UCTL1 |= CHAR;  // 8-bit char, UART-mode

		U1RCTL &= ~URXEIE;  // even erroneous characters trigger interrupts

		UCTL1 = SWRST;
		UCTL1 |= CHAR;  // 8-bit char, UART-mode

		if (l_ssel & 0x80) {
			U1TCTL &= ~(SSEL_0 | SSEL_1 | SSEL_2 | SSEL_3);
			U1TCTL |= (l_ssel & 0x7F); 
		}
		else {
			U1TCTL &= ~(SSEL_0 | SSEL_1 | SSEL_2 | SSEL_3);
			U1TCTL |= SSEL_ACLK; // use ACLK, assuming 32khz
		}

		if ((l_mctl != 0) || (l_br != 0)) {
			U1BR0 = l_br & 0x0FF;
			U1BR1 = (l_br >> 8) & 0x0FF;
			U1MCTL = l_mctl;
		}
		else {
			U1BR0 = 0x03;   // 9600 baud
			U1BR1 = 0x00;
			U1MCTL = 0x4A;
		}

		ME2 &= ~USPIE1;   // USART1 SPI module disable
		ME2 |= (UTXE1 | URXE1);   // USART1 UART module enable

		U1CTL &= ~SWRST;

		IFG2 &= ~(UTXIFG1 | URXIFG1);
		IE2 &= ~(UTXIE1 | URXIE1);  // interrupt disabled

	#endif
#endif
}

#if defined(PLATFORM_MICAZ) || defined(PLATFORM_MICA2) || defined(PLATFORM_MICA2DOT)
#else // assume AVR architecture (e.g. TelosA, TelosB)
	bool isTxIntrPending()
	{
		if (U1TCTL & TXEPT)
			return TRUE;

		return FALSE;
	}
#endif

/**
 * Outputs a char to the UART.
 */
void UARTPutChar(char c)
{
	if (c == '\n')
		UARTPutChar('\r');


#if defined(PLATFORM_MICAZ) || defined(PLATFORM_MICA2) || defined(PLATFORM_MICA2DOT)
	// Wait for bit set
	while( !(UCSR0A & UDRE) );
	
	UDR0 = c;
	//loop_until_bit_is_set(UCSR0A, UDRE);
	// outb(UDR0,c);
#else // assume AVR architecture (e.g. TelosA, TelosB)
	U1TXBUF = c;  
	while( !isTxIntrPending() )  
		continue;
#endif
}

/**
 * Outputs the entire debugbuf to the UART, or until it encounters '\0'.
 */
void writedebug()
{
	uint16_t i = 0;

	while (debugbuf[i] != '\0' && i < DEBUGBUF_SIZE)
		UARTPutChar(debugbuf[i++]);
}



/**
 * Simplified sprintf
 */
#define SCRATCH 16
int sprintf(uint8_t *buf, const uint8_t *format, ...)
{
	uint8_t scratch[SCRATCH];
	uint8_t format_flag;
	uint32_t u_val=0, base;//modified by Andre Cunha
	uint8_t *ptr;
	va_list ap;

	//memset(scratch, 0, SCRATCH);

	buf[0] = '\0';  // KLDEBUG - fixes subtle bug ...
	va_start (ap, format);
	for (;;)
	{
		while ((format_flag = *format++) != '%')	// Until '%' or '\0'
		{
			if (!format_flag)
			{
				va_end (ap);
				return (0);
			}
			*buf = format_flag; buf++; *buf=0;
		}

		switch (format_flag = *format++)
		{
		case 'c':
			format_flag = va_arg(ap,int);
		
		default:
			*buf = format_flag; buf++; *buf=0;
			continue;
		
		case 'S':
		case 's':
			ptr = va_arg(ap,char *);
			strcat(buf, ptr);
			continue;
		
		case 'o':
			base = 8;
			*buf = '0'; buf++; *buf=0;
			goto CONVERSION_LOOP;
		
		case 'i':
			if (((int)u_val) < 0)
			{
				u_val = - u_val;
				*buf = '-'; buf++; *buf=0;
			}
			base = 10;
			goto CONVERSION_LOOP;
			// no break -> run into next case
		
		case 'd'://added by Andre Cunha
			if (((int32_t)u_val) < 0)
			{
				u_val = - u_val;
				*buf = '-'; buf++; *buf=0;
			}

			base = 10;
			goto CONVERSION_LOOP32;
		
		case 'u':
			base = 10;
			goto CONVERSION_LOOP;
		
		case 'x':
			base = 16;
			goto CONVERSION_LOOP;

		
		case 'y'://unsigned int 32 bits hexadecimal//added by Andre Cunha
			base = 16;
			goto CONVERSION_LOOP32;

		CONVERSION_LOOP:
			u_val = va_arg(ap,int);
			ptr = scratch + SCRATCH;
			*--ptr = 0;
			do
			{
				char ch = u_val % base + '0';
				if (ch > '9')
					ch += 'a' - '9' - 1;
				*--ptr = ch;
				u_val /= base;
			} while (u_val);
			
			strcat(buf, ptr);
			buf += strlen(ptr);
			break;

		CONVERSION_LOOP32:
			u_val = va_arg(ap,int32_t);
			ptr = scratch + SCRATCH;
			*--ptr = 0;
			do
			{
				char ch = u_val % base + '0';
				if (ch > '9')
					ch += 'a' - '9' - 1;
				*--ptr = ch;
				u_val /= base;
			} while (u_val);
			
			strcat(buf, ptr);
			buf += strlen(ptr);
		}
	}
}


#endif  // PRINTFUART_ENABLED
// -------------------------------------------------------------------

#endif  // PRINTFUART_H