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 /**   NAND 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_nand_flash_page_ecc_compute                     PORTABLE C      */
43 /*                                                           6.1.7        */
44 /*  AUTHOR                                                                */
45 /*                                                                        */
46 /*    William E. Lamie, Microsoft Corporation                             */
47 /*                                                                        */
48 /*  DESCRIPTION                                                           */
49 /*                                                                        */
50 /*    This function computes the ECC for a NAND flash page.               */
51 /*                                                                        */
52 /*  INPUT                                                                 */
53 /*                                                                        */
54 /*    nand_flash                            NAND flash instance           */
55 /*    page_buffer                           Page buffer                   */
56 /*    ecc_buffer                            Returned ECC buffer           */
57 /*                                                                        */
58 /*  OUTPUT                                                                */
59 /*                                                                        */
60 /*    return status                                                       */
61 /*                                                                        */
62 /*  CALLS                                                                 */
63 /*                                                                        */
64 /*    _lx_nand_flash_256byte_ecc_compute    Compute ECC for 256 bytes     */
65 /*                                                                        */
66 /*  CALLED BY                                                             */
67 /*                                                                        */
68 /*    NAND flash driver                                                   */
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 /*                                                                        */
80 /**************************************************************************/
_lx_nand_flash_page_ecc_compute(LX_NAND_FLASH * nand_flash,UCHAR * page_buffer,UCHAR * ecc_buffer)81 UINT  _lx_nand_flash_page_ecc_compute(LX_NAND_FLASH *nand_flash, UCHAR *page_buffer, UCHAR *ecc_buffer)
82 {
83 
84 UINT    bytes_computed;
85 
86 
87     /* Loop to compute the ECC over the entire NAND flash page.  */
88     bytes_computed =  0;
89     while (bytes_computed < nand_flash -> lx_nand_flash_bytes_per_page)
90     {
91 
92         /* Compute the ECC for this 256 byte piece of the page.  */
93         _lx_nand_flash_256byte_ecc_compute(page_buffer, ecc_buffer);
94 
95         /* Move to the next 256 byte portion of the page.  */
96         bytes_computed =  bytes_computed + 256;
97 
98         /* Move the page buffer forward.  */
99         page_buffer =  page_buffer + 256;
100 
101         /* Move the ECC buffer forward, note there are 3 bytes of ECC per page. */
102         ecc_buffer =   ecc_buffer + 3;
103     }
104 
105     /* Return success.  */
106     return(LX_SUCCESS);
107 }
108 
109