sio.h 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  1. /*
  2. * Copyright (c) 2001-2004 Swedish Institute of Computer Science.
  3. * All rights reserved.
  4. *
  5. * Redistribution and use in source and binary forms, with or without modification,
  6. * are permitted provided that the following conditions are met:
  7. *
  8. * 1. Redistributions of source code must retain the above copyright notice,
  9. * this list of conditions and the following disclaimer.
  10. * 2. Redistributions in binary form must reproduce the above copyright notice,
  11. * this list of conditions and the following disclaimer in the documentation
  12. * and/or other materials provided with the distribution.
  13. * 3. The name of the author may not be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
  17. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  18. * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
  19. * SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  20. * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
  21. * OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  22. * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  23. * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  24. * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
  25. * OF SUCH DAMAGE.
  26. *
  27. * This file is part of the lwIP TCP/IP stack.
  28. */
  29. /*
  30. * This is the interface to the platform specific serial IO module
  31. * It needs to be implemented by those platforms which need SLIP or PPP
  32. */
  33. #ifndef __SIO_H__
  34. #define __SIO_H__
  35. #include "lwip/arch.h"
  36. #ifdef __cplusplus
  37. extern "C" {
  38. #endif
  39. /* If you want to define sio_fd_t elsewhere or differently,
  40. define this in your cc.h file. */
  41. #ifndef __sio_fd_t_defined
  42. typedef void * sio_fd_t;
  43. #endif
  44. /* The following functions can be defined to something else in your cc.h file
  45. or be implemented in your custom sio.c file. */
  46. #ifndef sio_open
  47. /**
  48. * Opens a serial device for communication.
  49. *
  50. * @param devnum device number
  51. * @return handle to serial device if successful, NULL otherwise
  52. */
  53. sio_fd_t sio_open(u8_t devnum)ICACHE_FLASH_ATTR;
  54. #endif
  55. #ifndef sio_send
  56. /**
  57. * Sends a single character to the serial device.
  58. *
  59. * @param c character to send
  60. * @param fd serial device handle
  61. *
  62. * @note This function will block until the character can be sent.
  63. */
  64. void sio_send(u8_t c, sio_fd_t fd)ICACHE_FLASH_ATTR;
  65. #endif
  66. #ifndef sio_recv
  67. /**
  68. * Receives a single character from the serial device.
  69. *
  70. * @param fd serial device handle
  71. *
  72. * @note This function will block until a character is received.
  73. */
  74. u8_t sio_recv(sio_fd_t fd)ICACHE_FLASH_ATTR;
  75. #endif
  76. #ifndef sio_read
  77. /**
  78. * Reads from the serial device.
  79. *
  80. * @param fd serial device handle
  81. * @param data pointer to data buffer for receiving
  82. * @param len maximum length (in bytes) of data to receive
  83. * @return number of bytes actually received - may be 0 if aborted by sio_read_abort
  84. *
  85. * @note This function will block until data can be received. The blocking
  86. * can be cancelled by calling sio_read_abort().
  87. */
  88. u32_t sio_read(sio_fd_t fd, u8_t *data, u32_t len)ICACHE_FLASH_ATTR;
  89. #endif
  90. #ifndef sio_tryread
  91. /**
  92. * Tries to read from the serial device. Same as sio_read but returns
  93. * immediately if no data is available and never blocks.
  94. *
  95. * @param fd serial device handle
  96. * @param data pointer to data buffer for receiving
  97. * @param len maximum length (in bytes) of data to receive
  98. * @return number of bytes actually received
  99. */
  100. u32_t sio_tryread(sio_fd_t fd, u8_t *data, u32_t len)ICACHE_FLASH_ATTR;
  101. #endif
  102. #ifndef sio_write
  103. /**
  104. * Writes to the serial device.
  105. *
  106. * @param fd serial device handle
  107. * @param data pointer to data to send
  108. * @param len length (in bytes) of data to send
  109. * @return number of bytes actually sent
  110. *
  111. * @note This function will block until all data can be sent.
  112. */
  113. u32_t sio_write(sio_fd_t fd, u8_t *data, u32_t len)ICACHE_FLASH_ATTR;
  114. #endif
  115. #ifndef sio_read_abort
  116. /**
  117. * Aborts a blocking sio_read() call.
  118. *
  119. * @param fd serial device handle
  120. */
  121. void sio_read_abort(sio_fd_t fd)ICACHE_FLASH_ATTR;
  122. #endif
  123. #ifdef __cplusplus
  124. }
  125. #endif
  126. #endif /* __SIO_H__ */