nrf_block_dev_empty.h 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  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. #ifndef NRF_BLOCK_DEV_EMPTY_H__
  41. #define NRF_BLOCK_DEV_EMPTY_H__
  42. #ifdef __cplusplus
  43. extern "C" {
  44. #endif
  45. #include "nrf_block_dev.h"
  46. #include "nrf_log_instance.h"
  47. /**@file
  48. *
  49. * @defgroup nrf_block_dev_empty Empty implementation
  50. * @ingroup nrf_block_dev
  51. *
  52. * This module implements block device API. It works like:
  53. * - /dev/empty for write operations
  54. * - /dev/zero for read operations
  55. * @{
  56. *
  57. */
  58. /**
  59. * @brief EMPTY block device operations
  60. * */
  61. extern const nrf_block_dev_ops_t nrf_block_device_empty_ops;
  62. /**
  63. * @brief Work structure of EMPTY block device.
  64. */
  65. typedef struct {
  66. nrf_block_dev_geometry_t geometry; //!< Block device geometry
  67. nrf_block_dev_ev_handler ev_handler; //!< Block device event handler
  68. void const * p_context; //!< Context handle passed to event handler
  69. } nrf_block_dev_empty_work_t;
  70. /**
  71. * @brief EMPTY block device config initializer (@ref nrf_block_dev_empty_config_t)
  72. *
  73. * @param blk_size Block size
  74. * @param blk_count Block count
  75. * */
  76. #define NRF_BLOCK_DEV_EMPTY_CONFIG(blk_size, blk_count) { \
  77. .block_size = (blk_size), \
  78. .block_count = (blk_count) \
  79. }
  80. /**
  81. * @brief EMPTY block device config
  82. */
  83. typedef struct {
  84. uint32_t block_size; //!< Desired block size
  85. uint32_t block_count; //!< Desired block count
  86. } nrf_block_dev_empty_config_t;
  87. /**
  88. * @brief EMPTY block device
  89. * */
  90. typedef struct {
  91. nrf_block_dev_t block_dev; //!< Block device
  92. nrf_block_dev_info_strings_t info_strings; //!< Block device information strings
  93. nrf_block_dev_empty_config_t empty_config; //!< EMPTY block device config
  94. nrf_block_dev_empty_work_t * p_work; //!< EMPTY block device work structure
  95. NRF_LOG_INSTANCE_PTR_DECLARE(p_log) //!< Pointer to instance of the logger object (Conditionally compiled).
  96. } nrf_block_dev_empty_t;
  97. /** @brief Name of the module used for logger messaging.
  98. */
  99. #define NRF_BLOCK_DEV_EMPTY_LOG_NAME block_dev_empty
  100. /**
  101. * @brief Defines a EMPTY block device.
  102. *
  103. * @param name Instance name
  104. * @param config Configuration @ref nrf_block_dev_empty_config_t
  105. * @param info Info strings @ref NFR_BLOCK_DEV_INFO_CONFIG
  106. * */
  107. #define NRF_BLOCK_DEV_EMPTY_DEFINE(name, config, info) \
  108. static nrf_block_dev_empty_work_t CONCAT_2(name, _work); \
  109. NRF_LOG_INSTANCE_REGISTER(NRF_BLOCK_DEV_EMPTY_LOG_NAME, name, \
  110. NRF_BLOCK_DEV_EMPTY_CONFIG_INFO_COLOR, \
  111. NRF_BLOCK_DEV_EMPTY_CONFIG_DEBUG_COLOR, \
  112. NRF_BLOCK_DEV_EMPTY_CONFIG_LOG_INIT_FILTER_LEVEL, \
  113. NRF_BLOCK_DEV_EMPTY_CONFIG_LOG_ENABLED ? \
  114. NRF_BLOCK_DEV_EMPTY_CONFIG_LOG_LEVEL : NRF_LOG_SEVERITY_NONE); \
  115. static const nrf_block_dev_empty_t name = { \
  116. .block_dev = { .p_ops = &nrf_block_device_empty_ops }, \
  117. .info_strings = BRACKET_EXTRACT(info), \
  118. .empty_config = config, \
  119. .p_work = &CONCAT_2(name, _work), \
  120. NRF_LOG_INSTANCE_PTR_INIT(p_log, NRF_BLOCK_DEV_EMPTY_LOG_NAME, name) \
  121. }
  122. /**
  123. * @brief Returns block device API handle from EMPTY block device.
  124. *
  125. * @param[in] p_blk_empty EMPTY block device
  126. * @return Block device handle
  127. */
  128. static inline nrf_block_dev_t const *
  129. nrf_block_dev_empty_ops_get(nrf_block_dev_empty_t const * p_blk_empty)
  130. {
  131. return &p_blk_empty->block_dev;
  132. }
  133. /** @} */
  134. #ifdef __cplusplus
  135. }
  136. #endif
  137. #endif /* NRF_BLOCK_DEV_EMPTY_H__ */