git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_A5_SAMA5D3x_Xplained_IAR/AtmelFiles/libchip_sama5d3x/include/async.h

   1 /* ----------------------------------------------------------------------------\r
   2  *         SAM Software Package License\r
   3  * ----------------------------------------------------------------------------\r
   4  * Copyright (c) 2011, 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  * \file\r
  32  *\r
  33  * Provide a routine for asynchronous transfer.\r
  34  *\r
  35  */\r
  36 \r
  37 #ifndef _ASYNC_\r
  38 #define _ASYNC_\r
  39 \r
  40 \r
  41 /*----------------------------------------------------------------------------\r
  42  *        Headers\r
  43  *----------------------------------------------------------------------------*/\r
  44 #include <stdint.h>\r
  45 \r
  46 /*----------------------------------------------------------------------------\r
  47  *        Definition\r
  48  *----------------------------------------------------------------------------*/\r
  49 /** Transfer is still pending.*/\r
  50 #define ASYNC_STATUS_PENDING        0xFF\r
  51 \r
  52 #ifdef __cplusplus\r
  53  extern "C" {\r
  54 #endif\r
  55 \r
  56 /*----------------------------------------------------------------------------\r
  57  *        Type\r
  58  *----------------------------------------------------------------------------*/\r
  59 /** \brief Asynchronous transfer descriptor. */\r
  60 typedef struct _Async\r
  61 {\r
  62     /** Asynchronous transfer status.*/\r
  63     volatile uint32_t status ;\r
  64     /** Callback function to invoke when transfer completes or fails.*/\r
  65     void *callback ;\r
  66     /** Driver storage area; do not use.*/\r
  67     uint8_t pStorage[9] ;\r
  68 } Async ;\r
  69 \r
  70 /*----------------------------------------------------------------------------\r
  71  *        Global functions\r
  72  *----------------------------------------------------------------------------*/\r
  73 extern uint32_t ASYNC_IsFinished( Async* pAsync ) ;\r
  74 \r
  75 #ifdef __cplusplus\r
  76 }\r
  77 #endif\r
  78 \r
  79 #endif /* #ifndef _ASYNC_ */\r
  80 \r