git.sur5r.net Git - freertos/blob - Demo/Common/drivers/Atmel/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 /// \dir\r
  32 /// !Purpose\r
  33 /// \r
  34 /// This module provides definitions and functions for using the DBGU.\r
  35 ///\r
  36 /// !Usage\r
  37 /// \r
  38 /// -# Enable the DBGU pins (see pio.h).\r
  39 /// -# Configure the DBGU using DBGU_Configure.\r
  40 ///\r
  41 /// \note Unless specified, all the functions defined here operate synchronously;\r
  42 /// i.e. they all wait the data is sent/received before returning.\r
  43 //------------------------------------------------------------------------------\r
  44 \r
  45 #ifndef DBGU_H\r
  46 #define DBGU_H\r
  47 \r
  48 //------------------------------------------------------------------------------\r
  49 //         Definitions\r
  50 //------------------------------------------------------------------------------\r
  51 \r
  52 //------------------------------------------------------------------------------\r
  53 /// \page Modes\r
  54 /// This page lists several common operating modes for the DBGU.\r
  55 /// !Modes\r
  56 /// - DBGU_STANDARD\r
  57  \r
  58 /// Standard operating mode (asynchronous, 8bit, no parity)\r
  59 #define DBGU_STANDARD           AT91C_US_PAR_NONE\r
  60 //------------------------------------------------------------------------------\r
  61 \r
  62 //------------------------------------------------------------------------------\r
  63 //      Exported functions\r
  64 //------------------------------------------------------------------------------\r
  65 extern void DBGU_Configure(unsigned int mode,\r
  66                            unsigned int baudrate,\r
  67                            unsigned int mck);\r
  68 \r
  69 extern unsigned char DBGU_GetChar();\r
  70 \r
  71 #endif //#ifndef DBGU_H\r
  72 \r