1 /*
2 * Copyright (C) 2017 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_mxc.c
34 *
35 * HAL abstraction for Flash memory that can be written anywhere
36 * after being erased implemented with memory
37 */
38
39 #include <stdint.h>
40 #include <string.h> // memcpy
41
42 #include "hal_flash_bank_mxc.h"
43
44 #include "flc.h" // Maxim Flash Controller
45
hal_flash_bank_mxc_get_size(void * context)46 static uint32_t hal_flash_bank_mxc_get_size(void * context){
47 hal_flash_bank_mxc_t * self = (hal_flash_bank_mxc_t *) context;
48 return self->sector_size;
49 }
50
hal_flash_bank_mxc_get_alignment(void * context)51 static uint32_t hal_flash_bank_mxc_get_alignment(void * context){
52 (void)(context);
53 return 4;
54 }
55
hal_flash_bank_mxc_erase(void * context,int bank)56 static void hal_flash_bank_mxc_erase(void * context, int bank){
57 hal_flash_bank_mxc_t * self = (hal_flash_bank_mxc_t *) context;
58
59 if (bank > 1) return;
60
61 // Erase page
62 FLC_PageErase(self->banks[bank], MXC_V_FLC_ERASE_CODE_PAGE_ERASE, MXC_V_FLC_FLSH_UNLOCK_KEY);
63 }
64
hal_flash_bank_mxc_read(void * context,int bank,uint32_t offset,uint8_t * buffer,uint32_t size)65 static void hal_flash_bank_mxc_read(void * context, int bank, uint32_t offset, uint8_t * buffer, uint32_t size){
66 hal_flash_bank_mxc_t * self = (hal_flash_bank_mxc_t *) context;
67
68 if (bank > 1) return;
69 if (offset > self->sector_size) return;
70 if ((offset + size) > self->sector_size) return;
71
72 memcpy(buffer, ((uint8_t *) self->banks[bank]) + offset, size);
73 }
74
hal_flash_bank_mxc_write(void * context,int bank,uint32_t offset,const uint8_t * data,uint32_t size)75 static void hal_flash_bank_mxc_write(void * context, int bank, uint32_t offset, const uint8_t * data, uint32_t size){
76 hal_flash_bank_mxc_t * self = (hal_flash_bank_mxc_t *) context;
77
78 if (bank > 1) return;
79 if (offset > self->sector_size) return;
80 if ((offset + size) > self->sector_size) return;
81
82 FLC_Write(self->banks[bank] + offset, data, size, MXC_V_FLC_FLSH_UNLOCK_KEY);
83 }
84
85 static const hal_flash_bank_t hal_flash_bank_mxc_impl = {
86 /* uint32_t (*get_size)() */ &hal_flash_bank_mxc_get_size,
87 /* uint32_t (*get_alignment)(..); */ &hal_flash_bank_mxc_get_alignment,
88 /* void (*erase)(..); */ &hal_flash_bank_mxc_erase,
89 /* void (*read)(..); */ &hal_flash_bank_mxc_read,
90 /* void (*write)(..); */ &hal_flash_bank_mxc_write,
91 };
92
hal_flash_bank_mxc_init_instance(hal_flash_bank_mxc_t * context,uint32_t sector_size,uintptr_t bank_0_addr,uintptr_t bank_1_addr)93 const hal_flash_bank_t * hal_flash_bank_mxc_init_instance(hal_flash_bank_mxc_t * context, uint32_t sector_size,
94 uintptr_t bank_0_addr, uintptr_t bank_1_addr){
95 context->sector_size = sector_size;
96 context->banks[0] = bank_0_addr;
97 context->banks[1] = bank_1_addr;
98
99 // prepare FLC
100 FLC_Init();
101
102 return &hal_flash_bank_mxc_impl;
103 }
104
105