summaryrefslogtreecommitdiff
path: root/n
diff options
context:
space:
mode:
authorschodet2005-06-27 21:54:52 +0000
committerschodet2005-06-27 21:54:52 +0000
commitd7efb62422691831607a5cfff4cad1db7ff0cbc8 (patch)
treeb13c946aeac9d17cdefe588e0305fef9b11ef69f /n
parent13f01c42208de5f77acda5ea39f0f69061b87f35 (diff)
Petites mise à jour de licence et de doc.
Diffstat (limited to 'n')
-rw-r--r--n/avr/modules/uart/README23
-rw-r--r--n/avr/modules/uart/uart.h50
-rw-r--r--n/avr/modules/uart/uart.txt7
3 files changed, 54 insertions, 26 deletions
diff --git a/n/avr/modules/uart/README b/n/avr/modules/uart/README
index 02d3af1..4ec8736 100644
--- a/n/avr/modules/uart/README
+++ b/n/avr/modules/uart/README
@@ -1 +1,24 @@
avr.uart - UART AVR module.
+
+Uart module for AVR. See modules README for more details about AVR modules.
+
+
+Copyright (C) 2005 Nicolas Schodet
+
+Robot APB Team/Efrei 2006.
+ Web: http://assos.efrei.fr/robot/
+ Email: robot AT efrei DOT fr
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
diff --git a/n/avr/modules/uart/uart.h b/n/avr/modules/uart/uart.h
index 8d49789..09a65d9 100644
--- a/n/avr/modules/uart/uart.h
+++ b/n/avr/modules/uart/uart.h
@@ -1,29 +1,29 @@
#ifndef uart_h
#define uart_h
-// uart.h
-// avr.uart - UART AVR module. {{{
-//
-// Copyright (C) 2005 Nicolas Schodet
-//
-// Robot APB Team/Efrei 2006.
-// Web: http://assos.efrei.fr/robot/
-// Email: robot AT efrei DOT fr
-//
-// This program is free software; you can redistribute it and/or modify
-// it under the terms of the GNU General Public License as published by
-// the Free Software Foundation; either version 2 of the License, or
-// (at your option) any later version.
-//
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-// GNU General Public License for more details.
-//
-// You should have received a copy of the GNU General Public License
-// along with this program; if not, write to the Free Software
-// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
-//
-// }}}
+/* uart.h */
+/* avr.uart - UART AVR module. {{{
+ *
+ * Copyright (C) 2005 Nicolas Schodet
+ *
+ * Robot APB Team/Efrei 2006.
+ * Web: http://assos.efrei.fr/robot/
+ * Email: robot AT efrei DOT fr
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * }}} */
#include <stdint.h>
@@ -67,4 +67,4 @@ uart1_error (void);
uint8_t
uart1_poll (void);
-#endif // uart_h
+#endif /* uart_h */
diff --git a/n/avr/modules/uart/uart.txt b/n/avr/modules/uart/uart.txt
index c0e9aa9..bdeebfa 100644
--- a/n/avr/modules/uart/uart.txt
+++ b/n/avr/modules/uart/uart.txt
@@ -4,7 +4,12 @@
* Utilisation
Rien de plus simple. Appeler la fonction |uart0_init| au démarrage, puis
-|uart0_putc| pour envoyer un caractère, |uart0_getc| pour en recevoir.
+|uart0_putc| pour envoyer un caractère, |uart0_getc| pour en recevoir. La
+fonction |uart0_poll| permet de connaître à l'avance le nombre de caractères
+disponibles.
+
+Actuellement la fonction |uart_error| permet de détecter les erreurs de
+transmission, mais cela va être remplacé par un mécanisme semblable à termios.
On peut configurer deux uarts, dans ce cas les fonctions sont en double.