begriffs open source - cmsis-freertos/blob - Demo/WizNET_DEMO_GCC

1 /*

4

5 VISIT http://www.FreeRTOS.org TO ENSURE YOU ARE USING THE LATEST VERSION.

6

7 This file is part of the FreeRTOS distribution.

8

9 FreeRTOS is free software; you can redistribute it and/or modify it under

10 the terms of the GNU General Public License (version 2) as published by the

11 Free Software Foundation >>>> AND MODIFIED BY <<<< the FreeRTOS exception.

12

13 ***************************************************************************

14 >>! NOTE: The modification to the GPL is included to allow you to !<<

15 >>! distribute a combined work that includes FreeRTOS without being !<<

16 >>! obliged to provide the source code for proprietary components !<<

17 >>! outside of the FreeRTOS kernel. !<<

18 ***************************************************************************

19

20 FreeRTOS is distributed in the hope that it will be useful, but WITHOUT ANY

21 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS

22 FOR A PARTICULAR PURPOSE. Full license text is available on the following

23 link: http://www.freertos.org/a00114.html

24

25 ***************************************************************************

26 * *

27 * FreeRTOS provides completely free yet professionally developed, *

28 * robust, strictly quality controlled, supported, and cross *

29 * platform software that is more than just the market leader, it *

30 * is the industry's de facto standard. *

31 * *

32 * Help yourself get started quickly while simultaneously helping *

33 * to support the FreeRTOS project by purchasing a FreeRTOS *

34 * tutorial book, reference manual, or both: *

35 * http://www.FreeRTOS.org/Documentation *

36 * *

37 ***************************************************************************

38

39 http://www.FreeRTOS.org/FAQHelp.html - Having a problem? Start by reading

40 the FAQ page "My application does not run, what could be wrong?". Have you

41 defined configASSERT()?

42

43 http://www.FreeRTOS.org/support - In return for receiving this top quality

44 embedded software for free we request you assist our global community by

45 participating in the support forum.

46

47 http://www.FreeRTOS.org/training - Investing in training allows your team to

48 be as productive as possible as early as possible. Now you can receive

49 FreeRTOS training directly from Richard Barry, CEO of Real Time Engineers

50 Ltd, and the world's leading authority on the world's leading RTOS.

51

52 http://www.FreeRTOS.org/plus - A selection of FreeRTOS ecosystem products,

53 including FreeRTOS+Trace - an indispensable productivity tool, a DOS

54 compatible FAT file system, and our tiny thread aware UDP/IP stack.

55

56 http://www.FreeRTOS.org/labs - Where new FreeRTOS products go to incubate.

57 Come and try FreeRTOS+TCP, our new open source TCP/IP stack for FreeRTOS.

58

59 http://www.OpenRTOS.com - Real Time Engineers ltd. license FreeRTOS to High

60 Integrity Systems ltd. to sell under the OpenRTOS brand. Low cost OpenRTOS

61 licenses offer ticketed support, indemnification and commercial middleware.

62

63 http://www.SafeRTOS.com - High Integrity Systems also provide a safety

64 engineered and independently SIL3 certified version for use in safety and

65 mission critical applications that require provable dependability.

66

67 1 tab == 4 spaces!

68 */

69

70 #ifndef I2C_H

71 #define I2C_H

72

73 /* Structure used to capture the I2C message details. The structure is then

74 * queued for processing by the I2C ISR.

75 */

76 typedef struct AN_I2C_MESSAGE

77 {

78 long lMessageLength; /*< How many bytes of data to send or received - excluding the buffer address. */

79 unsigned char ucSlaveAddress; /*< The slave address of the WIZnet on the I2C bus. */

80 unsigned char ucBufferAddressLowByte; /*< The address within the WIZnet device to which data should be read from / written to. */

81 unsigned char ucBufferAddressHighByte; /*< As above, high byte. */

82 SemaphoreHandle_t xMessageCompleteSemaphore; /*< Contains a reference to a semaphore if the application tasks wants notifying when the message has been transacted. */

83 unsigned char *pucBuffer; /*< Pointer to the buffer from where data will be read for transmission, or into which received data will be placed. */

84 } xI2CMessage;

85

86 /* Constants to use as the ulDirection parameter of i2cMessage(). */

87 #define i2cWRITE ( ( unsigned long ) 0 )

88 #define i2cREAD ( ( unsigned long ) 1 )

89

90 /**

91 * Must be called once before any calls to i2cMessage.

92 */

93 void i2cInit( void );

94

95 /**

96 * Send or receive a message over the I2C bus.

97 *

98 * @param pucMessage The data to be transmitted or the buffer into which

99 * received data will be placed.

100 *

101 * @param lMessageLength The number of bytes to either transmit or receive.

102 *

103 * @param ucSlaveAddress The slave address of the WIZNet device on the I2C bus.

104 *

105 * @param usBufferAddress The address within the WIZNet device to which data is

106 * either written to or read from. The WIZnet has it's

107 * own Rx and Tx buffers.

108 *

109 * @param ulDirection Must be either i2cWRITE or i2cREAD as #defined above.

110 *

111 * @param xMessageCompleteSemaphore

112 * Can be used to pass a semaphore reference if the

113 * calling task want notification of when the message has

114 * completed. Otherwise NULL can be passed.

115 *

116 * @param xBlockTime The time to wait for a space in the message queue to

117 * become available should one not be available

118 * immediately.

119 */

120 void i2cMessage( const unsigned char * const pucMessage, long lMessageLength, unsigned char ucSlaveAddress, unsigned short usBufferAddress, unsigned long ulDirection, SemaphoreHandle_t xMessageCompleteSemaphore, TickType_t xBlockTime );

121

122 #endif

123