memoryMap.h File Reference

#include "interStatus.h"
#include "commonDataTypes.h"

Include dependency graph for memoryMap.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
InterStatus	memoryMap_Read32 (const Address address, UInt32 *data)
	memoryMap_Read32.
InterStatus	memoryMap_Write32 (const Address address, const UInt32 data)
	memoryMap_Write32.

Detailed Description

Author

Syed Uthman Affan uthma.nosp@m.n.ab.nosp@m.dulha.nosp@m.lim@.nosp@m.tusas.nosp@m..my, Ramza Anuar ramza.nosp@m..anu.nosp@m.ar@tu.nosp@m.sas..nosp@m.my

Memory Map Read and Write Function Header File

Function Documentation

memoryMap_Read32()

InterStatus memoryMap_Read32	(	const Address	address,
		UInt32 *	data )

memoryMap_Read32.

Reads 32-bit of data from the specified address.

Parameters

[in]	address	The address from which the data is to be read.
[out]	data	Pointer to store the read data.

Returns

InterStatus - Interface status return code, If no error occurs during the operation of the function, it returns INTF_SUCCESS. Otherwise related error message is returned.

Return values

INTF_SUCCESS	: Success.
ERR_MMAP_FAIL_TO_MAP	: Unable to read to a certain register.

Low-Level Software Requirements (LLR)

Low-Level Requirement Specification: memoryMap_Read32

Requirement ID	Parent HLR ID	Detailed Low-Level Requirement Statement (EARS Format)	Software Unit Reference	Verification Method	Status
LLR_MEMORYMAP_MEMORYMAP_READ32_01	HLR_IO_36773	WHEN memory address alignment validation fails ((address % 4) != 0), the memoryMap_Read32() function SHALL abort processing and return 0.	memoryMap.c:memoryMap_Read32()	Test	Closed
LLR_MEMORYMAP_MEMORYMAP_READ32_02	HLR_IO_36773	WHEN memory address is 4-byte aligned, the memoryMap_Read32() function SHALL dereference and return the volatile 32-bit unsigned word at memory address address.	memoryMap.c:memoryMap_Read32()	Test	Closed

Control Coupling Diagram (CCD)

Control Coupling Structure Chart

Data Coupling Diagram (DCD)

Data Coupling Structure Chart

Control Flow Diagram (CFD)

Control Flow Diagram

Data Flow Diagram (DFD)

Data Flow Diagram

Here is the call graph for this function:

Here is the caller graph for this function:

memoryMap_Write32()

InterStatus memoryMap_Write32	(	const Address	address,
		const UInt32	data )

memoryMap_Write32.

Write 32-bit of data to the specified address.

Parameters

[in]	address	The address to which the data will be written.
[in]	data	The 32-bit data to write.

Returns

InterStatus - Interface status return code, If no error occurs during the operation of the function, it returns INTF_SUCCESS. Otherwise related error message is returned.

Return values

INTF_SUCCESS	: Success.
ERR_MMAP_FAIL_TO_MAP	: Unable to write to a certain register.

Low-Level Software Requirements (LLR)

Low-Level Requirement Specification: memoryMap_Write32

Requirement ID	Parent HLR ID	Detailed Low-Level Requirement Statement (EARS Format)	Software Unit Reference	Verification Method	Status
LLR_MEMORYMAP_MEMORYMAP_WRITE32_01	HLR_IO_36773	WHEN memory address alignment validation fails ((address % 4) != 0), the memoryMap_Write32() function SHALL abort processing without performing memory write.	memoryMap.c:memoryMap_Write32()	Test	Closed
LLR_MEMORYMAP_MEMORYMAP_WRITE32_02	HLR_IO_36773	WHEN memory address is 4-byte aligned, the memoryMap_Write32() function SHALL write 32-bit unsigned word data to volatile memory address address.	memoryMap.c:memoryMap_Write32()	Test	Closed

Control Coupling Diagram (CCD)

Control Coupling Structure Chart

Data Coupling Diagram (DCD)

Data Coupling Structure Chart

Control Flow Diagram (CFD)

Control Flow Diagram

Data Flow Diagram (DFD)

Data Flow Diagram

Here is the call graph for this function:

Here is the caller graph for this function: