summaryrefslogtreecommitdiff
path: root/drivers/twi/twid.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/twi/twid.h')
-rw-r--r--drivers/twi/twid.h92
1 files changed, 92 insertions, 0 deletions
diff --git a/drivers/twi/twid.h b/drivers/twi/twid.h
new file mode 100644
index 0000000..c2a708e
--- /dev/null
+++ b/drivers/twi/twid.h
@@ -0,0 +1,92 @@
+/* ----------------------------------------------------------------------------
+ * ATMEL Microcontroller Software Support
+ * ----------------------------------------------------------------------------
+ * Copyright (c) 2008, Atmel Corporation
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * - Redistributions of source code must retain the above copyright notice,
+ * this list of conditions and the disclaimer below.
+ *
+ * Atmel's name may not be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
+ * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+ * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+ * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ * ----------------------------------------------------------------------------
+ */
+
+#ifndef TWID_H
+#define TWID_H
+
+//------------------------------------------------------------------------------
+// Headers
+//------------------------------------------------------------------------------
+
+#include <board.h>
+#include <drivers/async/async.h>
+
+//------------------------------------------------------------------------------
+// Global definitions
+//------------------------------------------------------------------------------
+
+/// TWI driver is currently busy.
+#define TWID_ERROR_BUSY 1
+/// TWI driver operation timeout.
+#define TWID_ERROR_TIMEOUT 2
+
+//------------------------------------------------------------------------------
+// Global types
+//------------------------------------------------------------------------------
+
+//------------------------------------------------------------------------------
+/// TWI driver structure. Holds the internal state of the driver.
+//------------------------------------------------------------------------------
+typedef struct _Twid {
+
+ /// Pointer to the underlying TWI peripheral.
+ AT91S_TWI *pTwi;
+ /// Current asynchronous transfer being processed.
+ Async *pTransfer;
+
+} Twid;
+
+//------------------------------------------------------------------------------
+// Global functions
+//------------------------------------------------------------------------------
+
+extern void TWID_Initialize(Twid *pTwid, AT91S_TWI *pTwi);
+
+extern void TWID_Handler(Twid *pTwid);
+
+extern unsigned char TWID_Read(
+ Twid *pTwid,
+ unsigned char address,
+ unsigned int iaddress,
+ unsigned char isize,
+ unsigned char *pData,
+ unsigned int num,
+ Async *pAsync);
+
+extern unsigned char TWID_Write(
+ Twid *pTwid,
+ unsigned char address,
+ unsigned int iaddress,
+ unsigned char isize,
+ unsigned char *pData,
+ unsigned int num,
+ Async *pAsync);
+
+#endif //#ifndef TWID_H
+
personal git repositories of Harald Welte. Your mileage may vary