twi.h
上传用户:jnhtjd
上传日期:2022-07-16
资源大小:403k
文件大小:6k
源码类别:

微处理器开发

开发平台:

C/C++

  1. /* ----------------------------------------------------------------------------
  2.  *         ATMEL Microcontroller Software Support
  3.  * ----------------------------------------------------------------------------
  4.  * Copyright (c) 2008, 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. /// unit
  31. ///
  32. /// !Purpose
  33. ///
  34. /// Interface for configuration the Two Wire Interface (TWI) peripheral.
  35. ///
  36. /// !Usage
  37. ///
  38. /// -# Configures a TWI peripheral to operate in master mode, at the given
  39. /// frequency (in Hz) using TWI_ConfigureMaster().
  40. /// -# or if hardware possible, configures a TWI peripheral to operate in 
  41. /// slave mode, at the given frequency (in Hz) using TWI_ConfigureSlave().
  42. /// -# Sends a STOP condition on the TWI using TWI_Stop().
  43. /// -# Starts a read operation on the TWI bus with the specified slave using
  44. /// TWI_StartRead(). Data must then be read using TWI_ReadByte() whenever 
  45. /// a byte is available (poll using TWI_ByteReceived()).
  46. /// -# Starts a write operation on the TWI to access the selected slave using
  47. /// TWI_StartWrite(). A byte of data must be provided to start the write;
  48. /// other bytes are written next. 
  49. /// -# Sends a byte of data to one of the TWI slaves on the bus using TWI_WriteByte().
  50. /// This function must be called once before TWI_StartWrite() with the first byte of data
  51. /// to send, then it shall be called repeatedly after that to send the remaining bytes.
  52. /// -# Check if a byte has been received and can be read on the given TWI
  53. /// peripheral using TWI_ByteReceived(). 
  54. /// Check if a byte has been sent using TWI_ByteSent().
  55. /// -# Check if the current transmission is complete (the STOP has been sent)
  56. /// using TWI_TransferComplete().
  57. /// -# Enables & disable the selected interrupts sources on a TWI peripheral
  58. /// using TWI_EnableIt() and TWI_DisableIt().
  59. /// -# Get current status register of the given TWI peripheral using
  60. /// TWI_GetStatus(). Get current status register of the given TWI peripheral, but
  61. /// masking interrupt sources which are not currently enabled using 
  62. /// TWI_GetMaskedStatus().
  63. //------------------------------------------------------------------------------
  64. #ifndef TWI_H
  65. #define TWI_H
  66. //------------------------------------------------------------------------------
  67. //         Headers
  68. //------------------------------------------------------------------------------
  69. #include <board.h>
  70. //------------------------------------------------------------------------------
  71. //         Global definitions
  72. //------------------------------------------------------------------------------
  73. // Missing AT91C_TWI_TXRDY definition.
  74. #ifndef AT91C_TWI_TXRDY
  75.     #define AT91C_TWI_TXRDY   AT91C_TWI_TXRDY_MASTER
  76. #endif
  77. // Missing AT91C_TWI_TXCOMP definition.
  78. #ifndef AT91C_TWI_TXCOMP
  79.     #define AT91C_TWI_TXCOMP  AT91C_TWI_TXCOMP_MASTER
  80. #endif
  81. //------------------------------------------------------------------------------
  82. //         Global macros
  83. //------------------------------------------------------------------------------
  84. /// Returns 1 if the TXRDY bit (ready to transmit data) is set in the given
  85. /// status register value.
  86. #define TWI_STATUS_TXRDY(status) ((status & AT91C_TWI_TXRDY) == AT91C_TWI_TXRDY)
  87. /// Returns 1 if the RXRDY bit (ready to receive data) is set in the given
  88. /// status register value.
  89. #define TWI_STATUS_RXRDY(status) ((status & AT91C_TWI_RXRDY) == AT91C_TWI_RXRDY)
  90. /// Returns 1 if the TXCOMP bit (transfer complete) is set in the given
  91. /// status register value.
  92. #define TWI_STATUS_TXCOMP(status) ((status & AT91C_TWI_TXCOMP) == AT91C_TWI_TXCOMP)
  93. //------------------------------------------------------------------------------
  94. //         Global functions
  95. //------------------------------------------------------------------------------
  96. extern void TWI_ConfigureMaster(AT91S_TWI *pTwi, unsigned int twck, unsigned int mck);
  97. #ifdef AT91C_TWI_SVEN  // TWI slave
  98. extern void TWI_ConfigureSlave(AT91S_TWI *pTwi, unsigned char slaveAddress);
  99. #endif
  100. extern void TWI_Stop(AT91S_TWI *pTwi);
  101. extern void TWI_StartRead(
  102.     AT91S_TWI *pTwi,
  103.     unsigned char address,
  104.     unsigned int iaddress,
  105.     unsigned char isize);
  106. extern unsigned char TWI_ReadByte(AT91S_TWI *pTwi);
  107. extern void TWI_WriteByte(AT91S_TWI *pTwi, unsigned char byte);
  108. extern void TWI_StartWrite(
  109.     AT91S_TWI *pTwi,
  110.     unsigned char address,
  111.     unsigned int iaddress,
  112.     unsigned char isize,
  113.     unsigned char byte);
  114. extern unsigned char TWI_ByteReceived(AT91S_TWI *pTwi);
  115. extern unsigned char TWI_ByteSent(AT91S_TWI *pTwi);
  116. extern unsigned char TWI_TransferComplete(AT91S_TWI *pTwi);
  117. extern void TWI_EnableIt(AT91S_TWI *pTwi, unsigned int sources);
  118. extern void TWI_DisableIt(AT91S_TWI *pTwi, unsigned int sources);
  119. extern unsigned int TWI_GetStatus(AT91S_TWI *pTwi);
  120. extern unsigned int TWI_GetMaskedStatus(AT91S_TWI *pTwi);
  121. extern void TWI_SendSTOPCondition(AT91S_TWI *pTwi);
  122. #endif //#ifndef TWI_H