nrf_block_dev_empty.c 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269
  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. #include "sdk_common.h"
  41. #if NRF_MODULE_ENABLED(NRF_BLOCK_DEV_EMPTY)
  42. #include "nrf_block_dev_empty.h"
  43. #include <inttypes.h>
  44. /**@file
  45. *
  46. * @ingroup nrf_block_dev
  47. * @{
  48. *
  49. * @brief This module implements block device API. It would behave like:
  50. * - /dev/empty for write operations
  51. * - /dev/zero for read operations
  52. */
  53. #if NRF_BLOCK_DEV_EMPTY_CONFIG_LOG_ENABLED
  54. #define NRF_LOG_LEVEL NRF_BLOCK_DEV_EMPTY_CONFIG_LOG_LEVEL
  55. #define NRF_LOG_INFO_COLOR NRF_BLOCK_DEV_EMPTY_CONFIG_INFO_COLOR
  56. #define NRF_LOG_DEBUG_COLOR NRF_BLOCK_DEV_EMPTY_CONFIG_DEBUG_COLOR
  57. #else
  58. #define NRF_LOG_LEVEL 0
  59. #endif
  60. #include "nrf_log.h"
  61. static ret_code_t block_dev_empty_init(nrf_block_dev_t const * p_blk_dev,
  62. nrf_block_dev_ev_handler ev_handler,
  63. void const * p_context)
  64. {
  65. ASSERT(p_blk_dev);
  66. nrf_block_dev_empty_t const * p_empty_dev =
  67. CONTAINER_OF(p_blk_dev, nrf_block_dev_empty_t, block_dev);
  68. nrf_block_dev_empty_work_t * p_work = p_empty_dev->p_work;
  69. NRF_LOG_INST_DEBUG(p_empty_dev->p_log, "Init.");
  70. /* Calculate block device geometry.... */
  71. p_work->geometry.blk_size = p_empty_dev->empty_config.block_size;
  72. p_work->geometry.blk_count = p_empty_dev->empty_config.block_count;
  73. p_work->p_context = p_context;
  74. p_work->ev_handler = ev_handler;
  75. if (p_work->ev_handler)
  76. {
  77. /*Asynchronous operation (simulation)*/
  78. const nrf_block_dev_event_t ev = {
  79. NRF_BLOCK_DEV_EVT_INIT,
  80. NRF_BLOCK_DEV_RESULT_SUCCESS,
  81. NULL,
  82. p_work->p_context
  83. };
  84. p_work->ev_handler(p_blk_dev, &ev);
  85. }
  86. return NRF_SUCCESS;
  87. }
  88. static ret_code_t block_dev_empty_uninit(nrf_block_dev_t const * p_blk_dev)
  89. {
  90. ASSERT(p_blk_dev);
  91. nrf_block_dev_empty_t const * p_empty_dev =
  92. CONTAINER_OF(p_blk_dev, nrf_block_dev_empty_t, block_dev);
  93. nrf_block_dev_empty_work_t * p_work = p_empty_dev->p_work;
  94. NRF_LOG_INST_DEBUG(p_empty_dev->p_log, "Uninit.");
  95. if (p_work->ev_handler)
  96. {
  97. /*Asynchronous operation (simulation)*/
  98. const nrf_block_dev_event_t ev = {
  99. NRF_BLOCK_DEV_EVT_UNINIT,
  100. NRF_BLOCK_DEV_RESULT_SUCCESS,
  101. NULL,
  102. p_work->p_context
  103. };
  104. p_work->ev_handler(p_blk_dev, &ev);
  105. }
  106. memset(p_work, 0, sizeof(nrf_block_dev_empty_work_t));
  107. return NRF_SUCCESS;
  108. }
  109. static ret_code_t block_dev_empty_read_req(nrf_block_dev_t const * p_blk_dev,
  110. nrf_block_req_t const * p_blk)
  111. {
  112. ASSERT(p_blk_dev);
  113. ASSERT(p_blk);
  114. nrf_block_dev_empty_t const * p_empty_dev =
  115. CONTAINER_OF(p_blk_dev, nrf_block_dev_empty_t, block_dev);
  116. nrf_block_dev_empty_work_t * p_work = p_empty_dev->p_work;
  117. NRF_LOG_INST_DEBUG(
  118. p_empty_dev->p_log,
  119. "Read req from block %"PRIu32" size %"PRIu32"(x%"PRIu32") to %"PRIXPTR,
  120. p_blk->blk_id,
  121. p_blk->blk_count,
  122. p_blk_dev->p_ops->geometry(p_blk_dev)->blk_size,
  123. p_blk->p_buff);
  124. if ((p_blk->blk_id + p_blk->blk_count) > p_work->geometry.blk_count)
  125. {
  126. NRF_LOG_INST_ERROR(
  127. p_empty_dev->p_log,
  128. "Out of range read req block %"PRIu32" count %"PRIu32" while max is %"PRIu32,
  129. p_blk->blk_id,
  130. p_blk->blk_count,
  131. p_blk_dev->p_ops->geometry(p_blk_dev)->blk_count);
  132. return NRF_ERROR_INVALID_ADDR;
  133. }
  134. memset(p_blk->p_buff, 0, p_empty_dev->p_work->geometry.blk_size * p_blk->blk_count);
  135. if (p_work->ev_handler)
  136. {
  137. /*Asynchronous operation (simulation)*/
  138. const nrf_block_dev_event_t ev = {
  139. NRF_BLOCK_DEV_EVT_BLK_READ_DONE,
  140. NRF_BLOCK_DEV_RESULT_SUCCESS,
  141. p_blk,
  142. p_work->p_context
  143. };
  144. p_work->ev_handler(p_blk_dev, &ev);
  145. }
  146. return NRF_SUCCESS;
  147. }
  148. static ret_code_t block_dev_empty_write_req(nrf_block_dev_t const * p_blk_dev,
  149. nrf_block_req_t const * p_blk)
  150. {
  151. ASSERT(p_blk_dev);
  152. ASSERT(p_blk);
  153. nrf_block_dev_empty_t const * p_empty_dev =
  154. CONTAINER_OF(p_blk_dev, nrf_block_dev_empty_t, block_dev);
  155. nrf_block_dev_empty_work_t * p_work = p_empty_dev->p_work;
  156. NRF_LOG_INST_DEBUG(
  157. p_empty_dev->p_log,
  158. "Write req to block %"PRIu32" size %"PRIu32"(x%"PRIu32") from %"PRIXPTR,
  159. p_blk->blk_id,
  160. p_blk->blk_count,
  161. p_blk_dev->p_ops->geometry(p_blk_dev)->blk_size,
  162. p_blk->p_buff);
  163. if ((p_blk->blk_id + p_blk->blk_count) > p_work->geometry.blk_count)
  164. {
  165. NRF_LOG_INST_ERROR(
  166. p_empty_dev->p_log,
  167. "Out of range write req block %"PRIu32" count %"PRIu32" while max is %"PRIu32,
  168. p_blk->blk_id,
  169. p_blk->blk_count,
  170. p_blk_dev->p_ops->geometry(p_blk_dev)->blk_count);
  171. return NRF_ERROR_INVALID_ADDR;
  172. }
  173. if (p_work->ev_handler)
  174. {
  175. /*Asynchronous operation (simulation)*/
  176. const nrf_block_dev_event_t ev = {
  177. NRF_BLOCK_DEV_EVT_BLK_WRITE_DONE,
  178. NRF_BLOCK_DEV_RESULT_SUCCESS,
  179. p_blk,
  180. p_work->p_context
  181. };
  182. p_work->ev_handler(p_blk_dev, &ev);
  183. }
  184. return NRF_SUCCESS;
  185. }
  186. static ret_code_t block_dev_empty_ioctl(nrf_block_dev_t const * p_blk_dev,
  187. nrf_block_dev_ioctl_req_t req, void * p_data)
  188. {
  189. nrf_block_dev_empty_t const * p_empty_dev =
  190. CONTAINER_OF(p_blk_dev, nrf_block_dev_empty_t, block_dev);
  191. switch (req)
  192. {
  193. case NRF_BLOCK_DEV_IOCTL_REQ_CACHE_FLUSH:
  194. {
  195. bool * p_flushing = p_data;
  196. NRF_LOG_INST_DEBUG(p_empty_dev, "IOCtl: Cache flush");
  197. if (p_flushing)
  198. {
  199. *p_flushing = false;
  200. }
  201. return NRF_SUCCESS;
  202. }
  203. case NRF_BLOCK_DEV_IOCTL_REQ_INFO_STRINGS:
  204. {
  205. if (p_data == NULL)
  206. {
  207. return NRF_ERROR_INVALID_PARAM;
  208. }
  209. nrf_block_dev_info_strings_t const * * pp_strings = p_data;
  210. *pp_strings = &p_empty_dev->info_strings;
  211. return NRF_SUCCESS;
  212. }
  213. default:
  214. break;
  215. }
  216. return NRF_ERROR_NOT_SUPPORTED;
  217. }
  218. static nrf_block_dev_geometry_t const * block_dev_empty_geometry(nrf_block_dev_t const * p_blk_dev)
  219. {
  220. ASSERT(p_blk_dev);
  221. nrf_block_dev_empty_t const * p_empty_dev =
  222. CONTAINER_OF(p_blk_dev, nrf_block_dev_empty_t, block_dev);
  223. nrf_block_dev_empty_work_t const * p_work = p_empty_dev->p_work;
  224. return &p_work->geometry;
  225. }
  226. const nrf_block_dev_ops_t nrf_block_device_empty_ops = {
  227. .init = block_dev_empty_init,
  228. .uninit = block_dev_empty_uninit,
  229. .read_req = block_dev_empty_read_req,
  230. .write_req = block_dev_empty_write_req,
  231. .ioctl = block_dev_empty_ioctl,
  232. .geometry = block_dev_empty_geometry,
  233. };
  234. /** @} */
  235. #endif // NRF_MODULE_ENABLED(NRF_BLOCK_DEV_EMPTY)