xref: /btstack/port/msp432p401lp-cc256x/hal_flash_bank_msp432.c (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)
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_stm32.c
34  *
35  *  HAL abstraction for Flash memory that can be written anywhere
36  *  after being erased
37  */
38 
39 #include <stdint.h>
40 #include <string.h> // memcpy
41 
42 #include "hal_flash_bank_msp432.h"
43 #include "driverlib.h"
44 #include "btstack_defines.h"
45 
hal_flash_bank_msp432_get_size(void * context)46 static uint32_t hal_flash_bank_msp432_get_size(void * context){
47 	hal_flash_bank_msp432_t * self = (hal_flash_bank_msp432_t *) context;
48 	return self->sector_size;
49 }
50 
hal_flash_bank_memory_msp432_get_alignment(void * context)51 static uint32_t hal_flash_bank_memory_msp432_get_alignment(void * context){
52     UNUSED(context);
53     return 4;
54 }
55 
hal_flash_bank_msp432_erase(void * context,int bank)56 static void hal_flash_bank_msp432_erase(void * context, int bank){
57 
58 	hal_flash_bank_msp432_t * self = (hal_flash_bank_msp432_t *) context;
59 	if (bank > 1) return;
60 
61     /* Unprotecting sector  */
62     MAP_FlashCtl_unprotectSector(FLASH_MAIN_MEMORY_SPACE_BANK1,self->sectors[bank]);
63 
64     /* Trying to erase the sector. Within this function, the API will
65         automatically try to erase the maximum number of tries. If it fails,
66          trap in an infinite loop */
67     if(!MAP_FlashCtl_eraseSector(self->banks[bank]))
68         while(1);
69 
70     /* Setting the sector back to protected  */
71     MAP_FlashCtl_protectSector(FLASH_MAIN_MEMORY_SPACE_BANK1,self->sectors[bank]);
72 }
73 
hal_flash_bank_msp432_read(void * context,int bank,uint32_t offset,uint8_t * buffer,uint32_t size)74 static void hal_flash_bank_msp432_read(void * context, int bank, uint32_t offset, uint8_t * buffer, uint32_t size){
75 	hal_flash_bank_msp432_t * self = (hal_flash_bank_msp432_t *) context;
76 
77 	if (bank > 1) return;
78 	if (offset > self->sector_size) return;
79 	if ((offset + size) > self->sector_size) return;
80 
81 	memcpy(buffer, ((uint8_t *) self->banks[bank]) + offset, size);
82 }
83 
hal_flash_bank_msp432_write(void * context,int bank,uint32_t offset,const uint8_t * data,uint32_t size)84 static void hal_flash_bank_msp432_write(void * context, int bank, uint32_t offset, const uint8_t * data, uint32_t size){
85 	hal_flash_bank_msp432_t * self = (hal_flash_bank_msp432_t *) context;
86 
87 	if (bank > 1) return;
88 	if (offset > self->sector_size) return;
89 	if ((offset + size) > self->sector_size) return;
90 
91     /* Unprotecting sector  */
92     MAP_FlashCtl_unprotectSector(FLASH_MAIN_MEMORY_SPACE_BANK1,self->sectors[bank]);
93 
94     /* Trying to program the memory. Within this function, the API will
95         automatically try to program the maximum number of tries. If it fails,
96         trap inside an infinite loop */
97     if(!MAP_FlashCtl_programMemory( (void *) data,
98             (void*) ((uint8_t *) self->banks[bank]) + offset, size))
99                 while(1);
100 
101     /* Setting the sector back to protected  */
102     MAP_FlashCtl_protectSector(FLASH_MAIN_MEMORY_SPACE_BANK1,self->sectors[bank]);
103 }
104 
105 static const hal_flash_bank_t hal_flash_bank_msp432_impl = {
106 	/* uint32_t (*get_size)() */         &hal_flash_bank_msp432_get_size,
107 	/* uint32_t (*get_alignment)(..); */ &hal_flash_bank_memory_msp432_get_alignment,
108 	/* void (*erase)(..);             */ &hal_flash_bank_msp432_erase,
109 	/* void (*read)(..);              */ &hal_flash_bank_msp432_read,
110 	/* void (*write)(..);             */ &hal_flash_bank_msp432_write,
111 };
112 
hal_flash_bank_msp432_init_instance(hal_flash_bank_msp432_t * context,uint32_t sector_size,uint32_t bank_0_sector,uint32_t bank_1_sector,uintptr_t bank_0_addr,uintptr_t bank_1_addr)113 const hal_flash_bank_t * hal_flash_bank_msp432_init_instance(hal_flash_bank_msp432_t * context, uint32_t sector_size,
114 		uint32_t bank_0_sector, uint32_t bank_1_sector, uintptr_t bank_0_addr, uintptr_t bank_1_addr){
115 	context->sector_size = sector_size;
116 	context->sectors[0] = bank_0_sector;
117 	context->sectors[1] = bank_1_sector;
118 	context->banks[0]   = bank_0_addr;
119 	context->banks[1]   = bank_1_addr;
120 	return &hal_flash_bank_msp432_impl;
121 }
122