xref: /btstack/port/renesas-ek-ra6m4a-da14531/port/hal_flash_bank_fsp.h (revision c30869498fb8e98c1408c9db0e7624f02f483b73)
1 /*
2  * Copyright (C) 2020 BlueKitchen GmbH
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. Neither the name of the copyright holders nor the names of
14  *    contributors may be used to endorse or promote products derived
15  *    from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
20  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
21  * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
23  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
24  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
25  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
27  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28  * SUCH DAMAGE.
29  *
30  */
31 
32 /*
33  *  hal_flash_bank_fsp.h
34  *
35  *  HAL abstraction for Flash memory that can be written anywhere
36  *  after being erased
37  */
38 
39 #ifndef HAL_FLASH_BANK_FSP_H
40 #define HAL_FLASH_BANK_FSP_H
41 
42 #include <stdint.h>
43 #include "hal_flash_bank.h"
44 
45 #if defined __cplusplus
46 extern "C" {
47 #endif
48 
49 typedef struct {
50     uint32_t   bank_size;
51     uint32_t   block_size;
52     uint32_t   bank_addr[2];
53     uint32_t   blank_start[2];
54 } hal_flash_bank_fsp_t;
55 
56 /**
57  * Configure STM32 HAL Flash Implementation
58  *
59  * @param context of hal_flash_bank_synergy_t
60  * @param bank_size
61  * @param bank_0_page_id
62  * @param bank_1_page_id
63  * @return
64  */
65 const hal_flash_bank_t * hal_flash_bank_fsp_init_instance(hal_flash_bank_fsp_t * context, uint32_t bank_size,
66         uint32_t bank_0_addr, uint32_t bank_1_addr);
67 
68 #if defined __cplusplus
69 }
70 #endif
71 #endif
72