nrf_serial_flash_params.h 3.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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_SERIAL_FLASH_PARAMS_H__
  41. #define NRF_SERIAL_FLASH_PARAMS_H__
  42. #ifdef __cplusplus
  43. extern "C" {
  44. #endif
  45. #include "sdk_common.h"
  46. /**@file
  47. *
  48. * @defgroup nrf_serial_flash_params Serial flash memory parameters
  49. * @ingroup nrf_block_dev
  50. * @{
  51. *
  52. */
  53. /**
  54. * @brief Serial flash memory parameters
  55. * */
  56. typedef struct {
  57. uint8_t read_id[3]; //!< Read identification command (0x9F) result
  58. uint8_t capabilities; //!< Serial flash memory capabilities
  59. uint32_t size; //!< Serial flash memory size (bytes)
  60. uint32_t erase_size; //!< Serial flash memory erase unit size (bytes)
  61. uint32_t program_size; //!< Serial flash memory program size (bytes)
  62. } nrf_serial_flash_params_t;
  63. /**
  64. * @brief Returns serial flash memory identification descriptor
  65. *
  66. * @param p_read_params Memory read identification command result
  67. *
  68. * @return Serial flash memory descriptor (NULL if not found)
  69. * */
  70. nrf_serial_flash_params_t const * nrf_serial_flash_params_get(const uint8_t * p_read_params);
  71. /** @} */
  72. #ifdef __cplusplus
  73. }
  74. #endif
  75. #endif /* NRF_SERIAL_FLASH_PARAMS_H__ */