git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_AT91SAM3U256_IAR/AT91Lib/peripherals/dbgu/dbgu.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         ATMEL Microcontroller Software Support \r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2008, Atmel Corporation\r
   5  *\r
   6  * All rights reserved.\r
   7  *\r
   8  * Redistribution and use in source and binary forms, with or without\r
   9  * modification, are permitted provided that the following conditions are met:\r
  10  *\r
  11  * - Redistributions of source code must retain the above copyright notice,\r
  12  * this list of conditions and the disclaimer below.\r
  13  *\r
  14  * Atmel's name may not be used to endorse or promote products derived from\r
  15  * this software without specific prior written permission.\r
  16  *\r
  17  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR\r
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  20  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,\r
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\r
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,\r
  23  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF\r
  24  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\r
  25  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,\r
  26  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  27  * ----------------------------------------------------------------------------\r
  28  */\r
  29 \r
  30 //------------------------------------------------------------------------------\r
  31 /// \unit\r
  32 ///\r
  33 /// !Purpose\r
  34 /// \r
  35 /// This module provides definitions and functions for using the Debug Unit\r
  36 /// (DBGU).\r
  37 ///\r
  38 /// It also overloads the fputc(), fputs() & putchar() functions so the printf()\r
  39 /// method outputs its data on the DBGU. This behavior can be suppressed by\r
  40 /// defining NOFPUT during compilation.\r
  41 ///\r
  42 /// !Usage\r
  43 /// \r
  44 /// -# Enable the DBGU pins (see pio & board.h).\r
  45 /// -# Configure the DBGU using DBGU_Configure with the desired operating mode.\r
  46 /// -# Send characters using DBGU_PutChar() or the printf() method.\r
  47 /// -# Receive characters using DBGU_GetChar().\r
  48 ///\r
  49 /// \note Unless specified, all the functions defined here operate synchronously;\r
  50 /// i.e. they all wait the data is sent/received before returning.\r
  51 //------------------------------------------------------------------------------\r
  52 \r
  53 #ifndef DBGU_H\r
  54 #define DBGU_H\r
  55 \r
  56 //------------------------------------------------------------------------------\r
  57 //         Definitions\r
  58 //------------------------------------------------------------------------------\r
  59  \r
  60 /// Standard operating mode (asynchronous, 8bit, no parity, 1 stop bit)\r
  61 #define DBGU_STANDARD           AT91C_US_PAR_NONE\r
  62 \r
  63 //------------------------------------------------------------------------------\r
  64 //         Global functions\r
  65 //------------------------------------------------------------------------------\r
  66 \r
  67 extern void DBGU_Configure(\r
  68     unsigned int mode,\r
  69     unsigned int baudrate,\r
  70     unsigned int mck);\r
  71 \r
  72 extern unsigned char DBGU_GetChar(void);\r
  73 \r
  74 extern void DBGU_PutChar(unsigned char c);\r
  75 \r
  76 extern unsigned int DBGU_IsRxReady(void);\r
  77 \r
  78 #endif //#ifndef DBGU_H\r
  79 \r