spi_callback.h 3.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. /**
  2. * \file
  3. *
  4. * \brief SAM Serial Peripheral Interface Driver
  5. *
  6. * Copyright (C) 2015 Atmel Corporation. All rights reserved.
  7. *
  8. * \asf_license_start
  9. *
  10. * \page License
  11. *
  12. * Redistribution and use in source and binary forms, with or without
  13. * modification, are permitted provided that the following conditions are met:
  14. *
  15. * 1. Redistributions of source code must retain the above copyright notice,
  16. * this list of conditions and the following disclaimer.
  17. *
  18. * 2. Redistributions in binary form must reproduce the above copyright notice,
  19. * this list of conditions and the following disclaimer in the documentation
  20. * and/or other materials provided with the distribution.
  21. *
  22. * 3. The name of Atmel may not be used to endorse or promote products derived
  23. * from this software without specific prior written permission.
  24. *
  25. * 4. This software may only be redistributed and used in connection with an
  26. * Atmel microcontroller product.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED
  29. * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  30. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
  31. * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR
  32. * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33. * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34. * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  36. * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  37. * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38. * POSSIBILITY OF SUCH DAMAGE.
  39. *
  40. * \asf_license_stop
  41. *
  42. */
  43. /*
  44. * Support and FAQ: visit <a href="http://www.atmel.com/design-support/">Atmel Support</a>
  45. */
  46. #ifndef SPI_CALLBACK_H_INCLUDED
  47. #define SPI_CALLBACK_H_INCLUDED
  48. #ifdef __cplusplus
  49. extern "C" {
  50. #endif
  51. /**
  52. * \addtogroup asfdoc_samb_drivers_spi_group
  53. *
  54. * @{
  55. */
  56. #include "spi.h"
  57. /**
  58. * \name Callback Management
  59. * @{
  60. */
  61. void spi_register_callback(
  62. struct spi_module *const module,
  63. spi_callback_t callback_func,
  64. enum spi_callback callback_type);
  65. void spi_unregister_callback(
  66. struct spi_module *module,
  67. enum spi_callback callback_type);
  68. void spi_enable_callback(
  69. struct spi_module *const module,
  70. enum spi_callback callback_type);
  71. void spi_disable_callback(
  72. struct spi_module *const module,
  73. enum spi_callback callback_type);
  74. /** @} */
  75. /**
  76. * \name Writing and Reading
  77. * @{
  78. */
  79. enum status_code spi_write_buffer_job(
  80. struct spi_module *const module,
  81. uint8_t *tx_data,
  82. uint16_t length);
  83. enum status_code spi_read_buffer_job(
  84. struct spi_module *const module,
  85. uint8_t *rx_data,
  86. uint16_t length,
  87. uint16_t dummy);
  88. enum status_code spi_transceive_buffer_job(
  89. struct spi_module *const module,
  90. uint8_t *tx_data,
  91. uint8_t *rx_data,
  92. uint16_t length);
  93. /** @} */
  94. /** @} */
  95. #ifdef __cplusplus
  96. }
  97. #endif
  98. #endif //SPI_H_INCLUDED