1 /***************************************************************************
2  * Copyright (c) 2024 Microsoft Corporation
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the MIT License which is available at
6  * https://opensource.org/licenses/MIT.
7  *
8  * SPDX-License-Identifier: MIT
9  **************************************************************************/
10 
11 
12 /**************************************************************************/
13 /**************************************************************************/
14 /**                                                                       */
15 /** LevelX Component                                                      */
16 /**                                                                       */
17 /**   NAND Flash                                                          */
18 /**                                                                       */
19 /**************************************************************************/
20 /**************************************************************************/
21 
22 #define LX_SOURCE_CODE
23 
24 
25 /* Disable ThreadX error checking.  */
26 
27 #ifndef LX_DISABLE_ERROR_CHECKING
28 #define LX_DISABLE_ERROR_CHECKING
29 #endif
30 
31 
32 /* Include necessary system files.  */
33 
34 #include "lx_api.h"
35 
36 
37 /**************************************************************************/
38 /*                                                                        */
39 /*  FUNCTION                                               RELEASE        */
40 /*                                                                        */
41 /*    _lx_nand_flash_extended_cache_enable                PORTABLE C      */
42 /*                                                           6.2.1       */
43 /*  AUTHOR                                                                */
44 /*                                                                        */
45 /*    William E. Lamie, Microsoft Corporation                             */
46 /*                                                                        */
47 /*  DESCRIPTION                                                           */
48 /*                                                                        */
49 /*    This function sets up the extended NAND cache for block status,     */
50 /*    page extra bytes, and page 0 contents. The routine will enable as   */
51 /*    many cache capabilities as possible until the supplied memory is    */
52 /*    exhausted.                                                          */
53 /*                                                                        */
54 /*  INPUT                                                                 */
55 /*                                                                        */
56 /*    nand_flash                            NAND flash instance           */
57 /*    memory                                Pointer to memory for caches  */
58 /*    size                                  Size of memory in bytes       */
59 /*                                                                        */
60 /*  OUTPUT                                                                */
61 /*                                                                        */
62 /*    Completion Status                                                   */
63 /*                                                                        */
64 /*  CALLS                                                                 */
65 /*                                                                        */
66 /*    None                                                                */
67 /*                                                                        */
68 /*  CALLED BY                                                             */
69 /*                                                                        */
70 /*    Internal LevelX                                                     */
71 /*                                                                        */
72 /*  RELEASE HISTORY                                                       */
73 /*                                                                        */
74 /*    DATE              NAME                      DESCRIPTION             */
75 /*                                                                        */
76 /*  05-19-2020     William E. Lamie         Initial Version 6.0           */
77 /*  09-30-2020     William E. Lamie         Modified comment(s),          */
78 /*                                            resulting in version 6.1    */
79 /*  06-02-2021     Bhupendra Naphade        Modified comment(s),          */
80 /*                                            resulting in version 6.1.7  */
81 /*  03-08-2023     Xiuwen Cai               Modified comment(s),          */
82 /*                                            deprecated this API,        */
83 /*                                            resulting in version 6.2.1 */
84 /*                                                                        */
85 /**************************************************************************/
_lx_nand_flash_extended_cache_enable(LX_NAND_FLASH * nand_flash,VOID * memory,ULONG size)86 UINT  _lx_nand_flash_extended_cache_enable(LX_NAND_FLASH  *nand_flash, VOID *memory, ULONG size)
87 {
88 
89     LX_PARAMETER_NOT_USED(nand_flash);
90     LX_PARAMETER_NOT_USED(memory);
91     LX_PARAMETER_NOT_USED(size);
92 
93     /* Return not supported.  */
94     return(LX_NOT_SUPPORTED);
95 }
96 
97