diff options
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/block_dev/sdc/nrf_block_dev_sdc.h')
-rw-r--r-- | thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/block_dev/sdc/nrf_block_dev_sdc.h | 139 |
1 files changed, 139 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/block_dev/sdc/nrf_block_dev_sdc.h b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/block_dev/sdc/nrf_block_dev_sdc.h new file mode 100644 index 0000000..cab8032 --- /dev/null +++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/block_dev/sdc/nrf_block_dev_sdc.h @@ -0,0 +1,139 @@ +/** + * 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. + * + */ +/**@file + * + * @defgroup nrf_block_dev_sdc SDC implementation + * @ingroup nrf_block_dev + * @{ + * + */ + + +#ifndef NRF_BLOCK_DEV_SDC_H__ +#define NRF_BLOCK_DEV_SDC_H__ + +#ifdef __cplusplus +extern "C" { +#endif + +#include "nrf_block_dev.h" +#include "app_sdcard.h" + +/** + * @brief SDC block device operations + * */ +extern const nrf_block_dev_ops_t nrf_block_device_sdc_ops; + +/** + * @brief Work structure of SDC block device + */ +typedef struct { + nrf_block_dev_geometry_t geometry; //!< Block device geometry + nrf_block_dev_ev_handler ev_handler; //!< Block device event handler + nrf_block_req_t req; //!< Block READ/WRITE request + void const * p_context; //!< Context handle passed to event handler +} nrf_block_dev_sdc_work_t; + +/** + * @brief SDC block device config initializer (@ref nrf_block_dev_sdc_config_t) + * + * @param blk_size Block size + * @param sdc_lib_config SDC library config (@ref app_sdc_config_t) + * */ +#define NRF_BLOCK_DEV_SDC_CONFIG(blk_size, sdc_lib_config) \ +{ \ + .block_size = (blk_size), \ + .sdc_config = sdc_lib_config \ +} + + +/** + * @brief SDC block device config + */ +typedef struct { + uint32_t block_size; //!< Desired block size + app_sdc_config_t sdc_config; //!< SDC library configuration +} nrf_block_dev_sdc_config_t; + +/** + * @brief SDC 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_sdc_config_t sdc_bdev_config; //!< SDC block device config + nrf_block_dev_sdc_work_t * p_work; //!< SDC block device work structure +} nrf_block_dev_sdc_t; + +/** + * @brief Defines a SDC block device. + * + * @param name Instance name + * @param config Configuration @ref nrf_block_dev_sdc_config_t + * @param info Info strings @ref NFR_BLOCK_DEV_INFO_CONFIG + * */ +#define NRF_BLOCK_DEV_SDC_DEFINE(name, config, info) \ + static nrf_block_dev_sdc_work_t CONCAT_2(name, _work); \ + static const nrf_block_dev_sdc_t name = { \ + .block_dev = { .p_ops = &nrf_block_device_sdc_ops }, \ + .info_strings = BRACKET_EXTRACT(info), \ + .sdc_bdev_config = config, \ + .p_work = &CONCAT_2(name, _work), \ + } + +/** + * @brief Returns block device API handle from SDC block device. + * + * @param[in] p_blk_sdc SDC block device + * @return Block device handle + */ +static inline nrf_block_dev_t const * +nrf_block_dev_sdc_ops_get(nrf_block_dev_sdc_t const * p_blk_sdc) +{ + return &p_blk_sdc->block_dev; +} + +/** @} */ + +#ifdef __cplusplus +} +#endif + +#endif /* NRF_BLOCK_DEV_SDC_H__ */ |