diff options
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/block_dev/ram')
2 files changed, 345 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/block_dev/ram/nrf_block_dev_ram.c b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/block_dev/ram/nrf_block_dev_ram.c new file mode 100644 index 0000000..1acbab9 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/block_dev/ram/nrf_block_dev_ram.c @@ -0,0 +1,205 @@ +/** + * Copyright (c) 2016 - 2018, Nordic Semiconductor ASA + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form, except as embedded into a Nordic + * Semiconductor ASA integrated circuit in a product or a software update for + * such product, must reproduce the above copyright notice, this list of + * conditions and the following disclaimer in the documentation and/or other + * materials provided with the distribution. + * + * 3. Neither the name of Nordic Semiconductor ASA nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * 4. This software, with or without modification, must only be used with a + * Nordic Semiconductor ASA integrated circuit. + * + * 5. Any software provided in binary form under this license must not be reverse + * engineered, decompiled, modified and/or disassembled. + * + * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS + * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE + * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + */ +#include "nrf_block_dev_ram.h" + +/**@file + * + * @ingroup nrf_block_dev + * @{ + * + * @brief This module implements block device API. It should be used as a reference block device. + */ + +static ret_code_t block_dev_ram_init(nrf_block_dev_t const * p_blk_dev, + nrf_block_dev_ev_handler ev_handler, + void const * p_context) +{ + ASSERT(p_blk_dev); + nrf_block_dev_ram_t const * p_ram_dev = CONTAINER_OF(p_blk_dev, nrf_block_dev_ram_t, block_dev); + nrf_block_dev_ram_work_t * p_work = p_ram_dev->p_work; + + /* Calculate block device geometry.... */ + p_work->geometry.blk_size = p_ram_dev->ram_config.block_size; + p_work->geometry.blk_count = p_ram_dev->ram_config.size / + p_ram_dev->ram_config.block_size; + p_work->p_context = p_context; + p_work->ev_handler = ev_handler; + + if (p_work->ev_handler) + { + /*Asynchronous operation (simulation)*/ + const nrf_block_dev_event_t ev = { + NRF_BLOCK_DEV_EVT_INIT, + NRF_BLOCK_DEV_RESULT_SUCCESS, + NULL, + p_work->p_context + }; + + p_work->ev_handler(p_blk_dev, &ev); + } + + return NRF_SUCCESS; +} + +static ret_code_t block_dev_ram_uninit(nrf_block_dev_t const * p_blk_dev) +{ + ASSERT(p_blk_dev); + nrf_block_dev_ram_t const * p_ram_dev = CONTAINER_OF(p_blk_dev, nrf_block_dev_ram_t, block_dev); + nrf_block_dev_ram_work_t * p_work = p_ram_dev->p_work; + + if (p_work->ev_handler) + { + /*Asynchronous operation (simulation)*/ + const nrf_block_dev_event_t ev = { + NRF_BLOCK_DEV_EVT_UNINIT, + NRF_BLOCK_DEV_RESULT_SUCCESS, + NULL, + p_work->p_context + }; + + p_work->ev_handler(p_blk_dev, &ev); + } + + memset(p_work, 0, sizeof(nrf_block_dev_ram_work_t)); + return NRF_SUCCESS; +} + +static ret_code_t block_dev_ram_req(nrf_block_dev_t const * p_blk_dev, + nrf_block_req_t const * p_blk, + nrf_block_dev_event_type_t event) +{ + ASSERT(p_blk_dev); + ASSERT(p_blk); + nrf_block_dev_ram_t const * p_ram_dev = CONTAINER_OF(p_blk_dev, nrf_block_dev_ram_t, block_dev); + nrf_block_dev_ram_config_t const * p_ram_config = &p_ram_dev->ram_config; + nrf_block_dev_ram_work_t const * p_work = p_ram_dev->p_work; + + /*Synchronous operation*/ + uint8_t * p_buff = p_ram_config->p_work_buffer; + p_buff += p_blk->blk_id * p_work->geometry.blk_size; + + const void * p_src = (event == NRF_BLOCK_DEV_EVT_BLK_READ_DONE) ? p_buff : p_blk->p_buff; + void * p_dst = (event == NRF_BLOCK_DEV_EVT_BLK_READ_DONE) ? p_blk->p_buff : p_buff; + + memcpy(p_dst, p_src, p_work->geometry.blk_size * p_blk->blk_count); + + if (p_work->ev_handler) + { + /*Asynchronous operation (simulation)*/ + const nrf_block_dev_event_t ev = { + event, + NRF_BLOCK_DEV_RESULT_SUCCESS, + p_blk, + p_work->p_context + }; + + p_work->ev_handler(p_blk_dev, &ev); + } + + return NRF_SUCCESS; +} + +static ret_code_t block_dev_ram_read_req(nrf_block_dev_t const * p_blk_dev, + nrf_block_req_t const * p_blk) +{ + return block_dev_ram_req(p_blk_dev, p_blk, NRF_BLOCK_DEV_EVT_BLK_READ_DONE); +} + +static ret_code_t block_dev_ram_write_req(nrf_block_dev_t const * p_blk_dev, + nrf_block_req_t const * p_blk) +{ + return block_dev_ram_req(p_blk_dev, p_blk, NRF_BLOCK_DEV_EVT_BLK_WRITE_DONE); +} + +static ret_code_t block_dev_ram_ioctl(nrf_block_dev_t const * p_blk_dev, + nrf_block_dev_ioctl_req_t req, + void * p_data) +{ + nrf_block_dev_ram_t const * p_ram_dev = CONTAINER_OF(p_blk_dev, nrf_block_dev_ram_t, block_dev); + switch (req) + { + case NRF_BLOCK_DEV_IOCTL_REQ_CACHE_FLUSH: + { + bool * p_flushing = p_data; + if (p_flushing) + { + *p_flushing = false; + } + return NRF_SUCCESS; + } + case NRF_BLOCK_DEV_IOCTL_REQ_INFO_STRINGS: + { + if (p_data == NULL) + { + return NRF_ERROR_INVALID_PARAM; + } + + nrf_block_dev_info_strings_t const * * pp_strings = p_data; + *pp_strings = &p_ram_dev->info_strings; + return NRF_SUCCESS; + } + default: + break; + } + + return NRF_ERROR_NOT_SUPPORTED; +} + + +static nrf_block_dev_geometry_t const * block_dev_ram_geometry(nrf_block_dev_t const * p_blk_dev) +{ + ASSERT(p_blk_dev); + nrf_block_dev_ram_t const * p_ram_dev = CONTAINER_OF(p_blk_dev, nrf_block_dev_ram_t, block_dev); + nrf_block_dev_ram_work_t const * p_work = p_ram_dev->p_work; + + return &p_work->geometry; +} + +const nrf_block_dev_ops_t nrf_block_device_ram_ops = { + .init = block_dev_ram_init, + .uninit = block_dev_ram_uninit, + .read_req = block_dev_ram_read_req, + .write_req = block_dev_ram_write_req, + .ioctl = block_dev_ram_ioctl, + .geometry = block_dev_ram_geometry, +}; + + +/** @} */ diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/block_dev/ram/nrf_block_dev_ram.h b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/block_dev/ram/nrf_block_dev_ram.h new file mode 100644 index 0000000..d8046dc --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/block_dev/ram/nrf_block_dev_ram.h @@ -0,0 +1,140 @@ +/** + * Copyright (c) 2016 - 2018, Nordic Semiconductor ASA + * + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without modification, + * are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, this + * list of conditions and the following disclaimer. + * + * 2. Redistributions in binary form, except as embedded into a Nordic + * Semiconductor ASA integrated circuit in a product or a software update for + * such product, must reproduce the above copyright notice, this list of + * conditions and the following disclaimer in the documentation and/or other + * materials provided with the distribution. + * + * 3. Neither the name of Nordic Semiconductor ASA nor the names of its + * contributors may be used to endorse or promote products derived from this + * software without specific prior written permission. + * + * 4. This software, with or without modification, must only be used with a + * Nordic Semiconductor ASA integrated circuit. + * + * 5. Any software provided in binary form under this license must not be reverse + * engineered, decompiled, modified and/or disassembled. + * + * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS + * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE + * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE + * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) + * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT + * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT + * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + */ +#ifndef NRF_BLOCK_DEV_RAM_H__ +#define NRF_BLOCK_DEV_RAM_H__ + +#ifdef __cplusplus +extern "C" { +#endif + +#include "nrf_block_dev.h" + +/**@file + * + * @defgroup nrf_block_dev_ram RAM implementation + * @ingroup nrf_block_dev + * @{ + + * + * @brief This module implements block device API. It should be used as a reference block device. + */ + +/** + * @brief RAM block device operations + * */ +extern const nrf_block_dev_ops_t nrf_block_device_ram_ops; + +/** + * @brief Work structure of RAM block device + */ +typedef struct { + nrf_block_dev_geometry_t geometry; //!< Block device geometry + nrf_block_dev_ev_handler ev_handler; //!< Block device event handler + void const * p_context; //!< Context handle passed to event handler +} nrf_block_dev_ram_work_t; + + +/** + * @brief RAM block device config initializer (@ref nrf_block_dev_ram_config_t) + * + * @param blk_size Block size + * @param buffer RAM work buffer + * @param buffer_size RAM work buffer size + * */ +#define NRF_BLOCK_DEV_RAM_CONFIG(blk_size, buffer, buffer_size) { \ + .block_size = (blk_size), \ + .p_work_buffer = (buffer), \ + .size = (buffer_size), \ +} + +/** + * @brief Ram block device config + */ +typedef struct { + uint32_t block_size; //!< Desired block size + void * p_work_buffer; //!< Ram work buffer + size_t size; //!< Ram work buffer size +} nrf_block_dev_ram_config_t; + +/** + * @brief Ram block device + * */ +typedef struct { + nrf_block_dev_t block_dev; //!< Block device + nrf_block_dev_info_strings_t info_strings; //!< Block device information strings + nrf_block_dev_ram_config_t ram_config; //!< Ram block device config + nrf_block_dev_ram_work_t * p_work; //!< Ram block device work structure +} nrf_block_dev_ram_t; + +/** + * @brief Defines a RAM block device. + * + * @param name Instance name + * @param config Configuration @ref nrf_block_dev_ram_config_t + * @param info Info strings @ref NFR_BLOCK_DEV_INFO_CONFIG + * */ +#define NRF_BLOCK_DEV_RAM_DEFINE(name, config, info) \ + static nrf_block_dev_ram_work_t CONCAT_2(name, _work); \ + static const nrf_block_dev_ram_t name = { \ + .block_dev = { .p_ops = &nrf_block_device_ram_ops }, \ + .info_strings = BRACKET_EXTRACT(info), \ + .ram_config = config, \ + .p_work = &CONCAT_2(name, _work), \ + } + +/** + * @brief Returns block device API handle from RAM block device. + * + * @param[in] p_blk_ram Ram block device + * @return Block device handle + */ +static inline nrf_block_dev_t const * +nrf_block_dev_ram_ops_get(nrf_block_dev_ram_t const * p_blk_ram) +{ + return &p_blk_ram->block_dev; +} + +/** @} */ + +#ifdef __cplusplus +} +#endif + +#endif /* NRF_BLOCK_DEV_RAM_H__ */ |