blob: f332cb9ff583de4fc46814c7e3ff6ec10ed28c2e [file] [log] [blame]
Christina Quast637ace92014-11-28 13:28:37 +01001/* ----------------------------------------------------------------------------
2 * ATMEL Microcontroller Software Support
3 * ----------------------------------------------------------------------------
4 * Copyright (c) 2009, Atmel Corporation
5 *
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
11 * - Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the disclaimer below.
13 *
14 * Atmel's name may not be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
20 * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
23 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
24 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
25 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 * ----------------------------------------------------------------------------
28 */
29
30/**
31 * \file
32 *
33 * Provide a routine for asynchronous transfer.
34 *
35 */
36
37#ifndef _ASYNC_
38#define _ASYNC_
39
40
41/*----------------------------------------------------------------------------
42 * Headers
43 *----------------------------------------------------------------------------*/
44#include <stdint.h>
45
46/*----------------------------------------------------------------------------
47 * Definition
48 *----------------------------------------------------------------------------*/
49/** Transfer is still pending.*/
50#define ASYNC_STATUS_PENDING 0xFF
51
52#ifdef __cplusplus
53 extern "C" {
54#endif
55
56/*----------------------------------------------------------------------------
57 * Type
58 *----------------------------------------------------------------------------*/
59/** \brief Asynchronous transfer descriptor. */
60typedef struct _Async
61{
62 /** Asynchronous transfer status.*/
63 volatile uint8_t status ;
64 /** Callback function to invoke when transfer completes or fails.*/
65 void *callback ;
66 /** Driver storage area; do not use.*/
67 uint32_t pStorage[4] ;
68} Async ;
69
70/*----------------------------------------------------------------------------
71 * Global functions
72 *----------------------------------------------------------------------------*/
73extern uint32_t ASYNC_IsFinished( Async* pAsync ) ;
74
75#ifdef __cplusplus
76}
77#endif
78
79#endif /* #ifndef _ASYNC_ */
80