Head

GCC Code Coverage Report

Directory:	./		Exec	Total	Coverage
File:	lx_nand_flash_metadata_write.c	Lines:	18	22	81.8 %
Date:	2024-12-12 16:33:39	Branches:	5	8	62.5 %


/***************************************************************************
 * Copyright (c) 2024 Microsoft Corporation
 *
 * This program and the accompanying materials are made available under the
 * terms of the MIT License which is available at
 * https://opensource.org/licenses/MIT.
 *
 * SPDX-License-Identifier: MIT
 **************************************************************************/


/**************************************************************************/
/**************************************************************************/
/**                                                                       */
/** LevelX Component                                                      */
/**                                                                       */
/**   NAND Flash                                                          */
/**                                                                       */
/**************************************************************************/
/**************************************************************************/

#define LX_SOURCE_CODE


/* Disable ThreadX error checking.  */

#ifndef LX_DISABLE_ERROR_CHECKING
#define LX_DISABLE_ERROR_CHECKING
#endif


/* Include necessary system files.  */

#include "lx_api.h"


/**************************************************************************/
/*                                                                        */
/*  FUNCTION                                               RELEASE        */
/*                                                                        */
/*    _lx_nand_flash_metadata_write                       PORTABLE C      */
/*                                                           6.2.1       */
/*  AUTHOR                                                                */
/*                                                                        */
/*    Xiuwen Cai, Microsoft Corporation                                   */
/*                                                                        */
/*  DESCRIPTION                                                           */
/*                                                                        */
/*    This function writes metadata pages into current metadata block and */
/*    allocates new blocks for metadata.                                  */
/*                                                                        */
/*  INPUT                                                                 */
/*                                                                        */
/*    nand_flash                            NAND flash instance           */
/*    main_buffer                           Main page buffer              */
/*    spare_value                           Value for spare bytes         */
/*                                                                        */
/*  OUTPUT                                                                */
/*                                                                        */
/*    return status                                                       */
/*                                                                        */
/*  CALLS                                                                 */
/*                                                                        */
/*    lx_nand_flash_driver_pages_write      Driver pages write            */
/*    _lx_nand_flash_metadata_allocate      Allocate blocks for metadata  */
/*    _lx_nand_flash_system_error           Internal system error handler */
/*                                                                        */
/*  CALLED BY                                                             */
/*                                                                        */
/*    Internal LevelX                                                     */
/*                                                                        */
/*  RELEASE HISTORY                                                       */
/*                                                                        */
/*    DATE              NAME                      DESCRIPTION             */
/*                                                                        */
/*  03-08-2023     Xiuwen Cai               Initial Version 6.2.1        */
/*                                                                        */
/**************************************************************************/
UINT  _lx_nand_flash_metadata_write(LX_NAND_FLASH *nand_flash, UCHAR* main_buffer, ULONG spare_value)
{

ULONG   block;
ULONG   page;
UINT    status;
UCHAR   *spare_buffer_ptr;


    /* Setup spare buffer pointer.  */
    spare_buffer_ptr = nand_flash -> lx_nand_flash_page_buffer + nand_flash -> lx_nand_flash_bytes_per_page;

    /* Initialize the spare buffer.  */
    LX_MEMSET(spare_buffer_ptr, 0xFF, nand_flash -> lx_nand_flash_spare_total_length);

    /* Check if there is enough spare data for metadata block number.  */
    if (nand_flash -> lx_nand_flash_spare_data2_length >= 2)
    {

        /* Save metadata block number in spare bytes.  */
        LX_UTILITY_SHORT_SET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data2_offset], nand_flash -> lx_nand_flash_metadata_block_number);
    }

    /* Save metadata type data in spare bytes.  */
    LX_UTILITY_LONG_SET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset], spare_value);

    /* Get current metadata block number. */
    block = nand_flash -> lx_nand_flash_metadata_block_number_current;

    /* Get current metadata page number. */
    page = nand_flash -> lx_nand_flash_metadata_block_current_page;

    /* Write the page.  */
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
    status = (nand_flash -> lx_nand_flash_driver_pages_write)(nand_flash, block, page, main_buffer, spare_buffer_ptr, 1);
#else
    status = (nand_flash -> lx_nand_flash_driver_pages_write)(block, page, main_buffer, spare_buffer_ptr, 1);
#endif

    /* Check for an error from flash driver.   */
    if (status)
    {

        /* Call system error handler.  */
        _lx_nand_flash_system_error(nand_flash, status, block, 0);

        /* Return an error.  */
        return(status);
    }

    /* Increase current page for metadata block.  */
    nand_flash -> lx_nand_flash_metadata_block_current_page++;

    /* Get current backup metadata block number. */
    block = nand_flash -> lx_nand_flash_backup_metadata_block_number_current;

    /* Get current backup metadata page number. */
    page = nand_flash -> lx_nand_flash_backup_metadata_block_current_page;

    /* Write the page.  */
#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
    status = (nand_flash -> lx_nand_flash_driver_pages_write)(nand_flash, block, page, main_buffer, spare_buffer_ptr, 1);
#else
    status = (nand_flash -> lx_nand_flash_driver_pages_write)(block, page, main_buffer, spare_buffer_ptr, 1);
#endif

    /* Check for an error from flash driver.   */
    if (status)
    {

        /* Call system error handler.  */
        _lx_nand_flash_system_error(nand_flash, status, block, 0);

        /* Return an error.  */
        return(status);
    }

    /* Increase current page for backup metadata block.  */
    nand_flash -> lx_nand_flash_backup_metadata_block_current_page++;

    /* Allocate new block for metadata if necessary.  */
    _lx_nand_flash_metadata_allocate(nand_flash);

    /* Return sector not found status.  */
    return(status);
}



Generated by: GCOVR (Version 4.1)

Line	Branch	Exec	Source
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_metadata_write PORTABLE C */
42			/* 6.2.1 */
43			/* AUTHOR */
44			/* */
45			/* Xiuwen Cai, Microsoft Corporation */
46			/* */
47			/* DESCRIPTION */
48			/* */
49			/* This function writes metadata pages into current metadata block and */
50			/* allocates new blocks for metadata. */
51			/* */
52			/* INPUT */
53			/* */
54			/* nand_flash NAND flash instance */
55			/* main_buffer Main page buffer */
56			/* spare_value Value for spare bytes */
57			/* */
58			/* OUTPUT */
59			/* */
60			/* return status */
61			/* */
62			/* CALLS */
63			/* */
64			/* lx_nand_flash_driver_pages_write Driver pages write */
65			/* _lx_nand_flash_metadata_allocate Allocate blocks for metadata */
66			/* _lx_nand_flash_system_error Internal system error handler */
67			/* */
68			/* CALLED BY */
69			/* */
70			/* Internal LevelX */
71			/* */
72			/* RELEASE HISTORY */
73			/* */
74			/* DATE NAME DESCRIPTION */
75			/* */
76			/* 03-08-2023 Xiuwen Cai Initial Version 6.2.1 */
77			/* */
78			/**************************************************************************/
79		36946	UINT _lx_nand_flash_metadata_write(LX_NAND_FLASH nand_flash, UCHAR main_buffer, ULONG spare_value)
80			{
81
82			ULONG block;
83			ULONG page;
84			UINT status;
85			UCHAR *spare_buffer_ptr;
86
87
88			/* Setup spare buffer pointer. */
89		36946	spare_buffer_ptr = nand_flash -> lx_nand_flash_page_buffer + nand_flash -> lx_nand_flash_bytes_per_page;
90
91			/* Initialize the spare buffer. */
92	✓✓	628082	LX_MEMSET(spare_buffer_ptr, 0xFF, nand_flash -> lx_nand_flash_spare_total_length);
93
94			/* Check if there is enough spare data for metadata block number. */
95	✓✗	36946	if (nand_flash -> lx_nand_flash_spare_data2_length >= 2)
96			{
97
98			/* Save metadata block number in spare bytes. */
99		36946	LX_UTILITY_SHORT_SET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data2_offset], nand_flash -> lx_nand_flash_metadata_block_number);
100			}
101
102			/* Save metadata type data in spare bytes. */
103		36946	LX_UTILITY_LONG_SET(&spare_buffer_ptr[nand_flash -> lx_nand_flash_spare_data1_offset], spare_value);
104
105			/* Get current metadata block number. */
106		36946	block = nand_flash -> lx_nand_flash_metadata_block_number_current;
107
108			/* Get current metadata page number. */
109		36946	page = nand_flash -> lx_nand_flash_metadata_block_current_page;
110
111			/* Write the page. */
112			#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
113			status = (nand_flash -> lx_nand_flash_driver_pages_write)(nand_flash, block, page, main_buffer, spare_buffer_ptr, 1);
114			#else
115		36946	status = (nand_flash -> lx_nand_flash_driver_pages_write)(block, page, main_buffer, spare_buffer_ptr, 1);
116			#endif
117
118			/* Check for an error from flash driver. */
119	✗✓	36946	if (status)
120			{
121
122			/* Call system error handler. */
123			_lx_nand_flash_system_error(nand_flash, status, block, 0);
124
125			/* Return an error. */
126			return(status);
127			}
128
129			/* Increase current page for metadata block. */
130		36946	nand_flash -> lx_nand_flash_metadata_block_current_page++;
131
132			/* Get current backup metadata block number. */
133		36946	block = nand_flash -> lx_nand_flash_backup_metadata_block_number_current;
134
135			/* Get current backup metadata page number. */
136		36946	page = nand_flash -> lx_nand_flash_backup_metadata_block_current_page;
137
138			/* Write the page. */
139			#ifdef LX_NAND_ENABLE_CONTROL_BLOCK_FOR_DRIVER_INTERFACE
140			status = (nand_flash -> lx_nand_flash_driver_pages_write)(nand_flash, block, page, main_buffer, spare_buffer_ptr, 1);
141			#else
142		36946	status = (nand_flash -> lx_nand_flash_driver_pages_write)(block, page, main_buffer, spare_buffer_ptr, 1);
143			#endif
144
145			/* Check for an error from flash driver. */
146	✗✓	36946	if (status)
147			{
148
149			/* Call system error handler. */
150			_lx_nand_flash_system_error(nand_flash, status, block, 0);
151
152			/* Return an error. */
153			return(status);
154			}
155
156			/* Increase current page for backup metadata block. */
157		36946	nand_flash -> lx_nand_flash_backup_metadata_block_current_page++;
158
159			/* Allocate new block for metadata if necessary. */
160		36946	_lx_nand_flash_metadata_allocate(nand_flash);
161
162			/* Return sector not found status. */
163		36946	return(status);
164			}
165