nrf_block_dev_sdc.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. /**
  2. * Copyright (c) 2016 - 2020, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. /**@file
  41. *
  42. * @defgroup nrf_block_dev_sdc SDC implementation
  43. * @ingroup nrf_block_dev
  44. * @{
  45. *
  46. */
  47. #ifndef NRF_BLOCK_DEV_SDC_H__
  48. #define NRF_BLOCK_DEV_SDC_H__
  49. #ifdef __cplusplus
  50. extern "C" {
  51. #endif
  52. #include "nrf_block_dev.h"
  53. #include "app_sdcard.h"
  54. /**
  55. * @brief SDC block device operations
  56. * */
  57. extern const nrf_block_dev_ops_t nrf_block_device_sdc_ops;
  58. /**
  59. * @brief Work structure of SDC block device
  60. */
  61. typedef struct {
  62. nrf_block_dev_geometry_t geometry; //!< Block device geometry
  63. nrf_block_dev_ev_handler ev_handler; //!< Block device event handler
  64. nrf_block_req_t req; //!< Block READ/WRITE request
  65. void const * p_context; //!< Context handle passed to event handler
  66. } nrf_block_dev_sdc_work_t;
  67. /**
  68. * @brief SDC block device config initializer (@ref nrf_block_dev_sdc_config_t)
  69. *
  70. * @param blk_size Block size
  71. * @param sdc_lib_config SDC library config (@ref app_sdc_config_t)
  72. * */
  73. #define NRF_BLOCK_DEV_SDC_CONFIG(blk_size, sdc_lib_config) \
  74. { \
  75. .block_size = (blk_size), \
  76. .sdc_config = sdc_lib_config \
  77. }
  78. /**
  79. * @brief SDC block device config
  80. */
  81. typedef struct {
  82. uint32_t block_size; //!< Desired block size
  83. app_sdc_config_t sdc_config; //!< SDC library configuration
  84. } nrf_block_dev_sdc_config_t;
  85. /**
  86. * @brief SDC block device
  87. * */
  88. typedef struct {
  89. nrf_block_dev_t block_dev; //!< Block device
  90. nrf_block_dev_info_strings_t info_strings; //!< Block device information strings
  91. nrf_block_dev_sdc_config_t sdc_bdev_config; //!< SDC block device config
  92. nrf_block_dev_sdc_work_t * p_work; //!< SDC block device work structure
  93. } nrf_block_dev_sdc_t;
  94. /**
  95. * @brief Defines a SDC block device.
  96. *
  97. * @param name Instance name
  98. * @param config Configuration @ref nrf_block_dev_sdc_config_t
  99. * @param info Info strings @ref NFR_BLOCK_DEV_INFO_CONFIG
  100. * */
  101. #define NRF_BLOCK_DEV_SDC_DEFINE(name, config, info) \
  102. static nrf_block_dev_sdc_work_t CONCAT_2(name, _work); \
  103. static const nrf_block_dev_sdc_t name = { \
  104. .block_dev = { .p_ops = &nrf_block_device_sdc_ops }, \
  105. .info_strings = BRACKET_EXTRACT(info), \
  106. .sdc_bdev_config = config, \
  107. .p_work = &CONCAT_2(name, _work), \
  108. }
  109. /**
  110. * @brief Returns block device API handle from SDC block device.
  111. *
  112. * @param[in] p_blk_sdc SDC block device
  113. * @return Block device handle
  114. */
  115. static inline nrf_block_dev_t const *
  116. nrf_block_dev_sdc_ops_get(nrf_block_dev_sdc_t const * p_blk_sdc)
  117. {
  118. return &p_blk_sdc->block_dev;
  119. }
  120. /** @} */
  121. #ifdef __cplusplus
  122. }
  123. #endif
  124. #endif /* NRF_BLOCK_DEV_SDC_H__ */