1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** LevelX Component */
17 /** */
18 /** NOR Flash */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23 #define LX_SOURCE_CODE
24
25
26 /* Disable ThreadX error checking. */
27
28 #ifndef LX_DISABLE_ERROR_CHECKING
29 #define LX_DISABLE_ERROR_CHECKING
30 #endif
31
32
33 /* Include necessary system files. */
34
35 #include "lx_api.h"
36
37
38 /**************************************************************************/
39 /* */
40 /* FUNCTION RELEASE */
41 /* */
42 /* _lx_nor_flash_driver_block_erase PORTABLE C */
43 /* 6.2.1 */
44 /* AUTHOR */
45 /* */
46 /* William E. Lamie, Microsoft Corporation */
47 /* */
48 /* DESCRIPTION */
49 /* */
50 /* This function performs a NOR flash block erase. */
51 /* */
52 /* INPUT */
53 /* */
54 /* nor_flash NOR flash instance */
55 /* block Block number to erase */
56 /* erase_count Erase count for this block */
57 /* */
58 /* OUTPUT */
59 /* */
60 /* return status */
61 /* */
62 /* CALLS */
63 /* */
64 /* (lx_nor_flash_driver_block_erase) Actual driver block erase */
65 /* */
66 /* CALLED BY */
67 /* */
68 /* Application Code */
69 /* */
70 /* RELEASE HISTORY */
71 /* */
72 /* DATE NAME DESCRIPTION */
73 /* */
74 /* 05-19-2020 William E. Lamie Initial Version 6.0 */
75 /* 09-30-2020 William E. Lamie Modified comment(s), */
76 /* resulting in version 6.1 */
77 /* 06-02-2021 Bhupendra Naphade Modified comment(s), */
78 /* resulting in version 6.1.7 */
79 /* 03-08-2023 Xiuwen Cai Modified comment(s), */
80 /* added new driver interface, */
81 /* resulting in version 6.2.1 */
82 /* */
83 /**************************************************************************/
_lx_nor_flash_driver_block_erase(LX_NOR_FLASH * nor_flash,ULONG block,ULONG erase_count)84 UINT _lx_nor_flash_driver_block_erase(LX_NOR_FLASH *nor_flash, ULONG block, ULONG erase_count)
85 {
86
87 UINT status;
88
89 #ifndef LX_NOR_DISABLE_EXTENDED_CACHE
90
91 UINT i;
92 ULONG *block_start_address;
93 ULONG *block_end_address;
94 ULONG *cache_entry_start;
95 ULONG *cache_entry_end;
96
97
98 /* Calculate the block starting address. */
99 block_start_address = nor_flash -> lx_nor_flash_base_address + (block * nor_flash -> lx_nor_flash_words_per_block);
100 block_end_address = block_start_address + nor_flash -> lx_nor_flash_words_per_block;
101
102 /* Loop through the cache entries to see if there is a sector in cache. */
103 for (i = 0; i < nor_flash -> lx_nor_flash_extended_cache_entries; i++)
104 {
105
106 /* Search through the cache to see if this cache entry needs to be invalidated. */
107
108 /* Determine the cache entry addresses. */
109 cache_entry_start = nor_flash -> lx_nor_flash_extended_cache[i].lx_nor_flash_extended_cache_entry_sector_address;
110 cache_entry_end = cache_entry_start + LX_NOR_SECTOR_SIZE;
111
112 /* Determine if the flash address in in the cache entry. */
113 if ((cache_entry_start) && (block_start_address <= cache_entry_start) && (block_end_address > cache_entry_end))
114 {
115
116 /* Yes, this cache entry is in the block to be erased so invalidate it. */
117 nor_flash -> lx_nor_flash_extended_cache[i].lx_nor_flash_extended_cache_entry_sector_address = LX_NULL;
118 nor_flash -> lx_nor_flash_extended_cache[i].lx_nor_flash_extended_cache_entry_access_count = 0;
119 }
120 }
121 #endif
122
123 /* Call the actual driver block erase function. */
124 #ifdef LX_NOR_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
125 status = (nor_flash -> lx_nor_flash_driver_block_erase)(nor_flash, block, erase_count);
126 #else
127 status = (nor_flash -> lx_nor_flash_driver_block_erase)(block, erase_count);
128 #endif
129
130 /* Return completion status. */
131 return(status);
132 }
133
134
135
