interDrv.h File Reference

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

Include dependency graph for interDrv.h:

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

Go to the source code of this file.

Data Structures
struct	RegionInfo
	Memory Region Address and Status Mapping Configuration Structure. More...

Functions
Error	interDrv_memoryRegion_getAddress (RegionInfo *region)
	interDrv_memoryRegion_getAddress.
Error	interDrv_setAvailableRegion (const void *memRegion)
	interDrv_setAvailableRegion.
InterStatus	interDrv_Read32 (const Address address, UInt32 *data)
	interDrv_Read32.
InterStatus	interDrv_Write32 (const Address address, const UInt32 data)
	interDrv_Write32.

Detailed Description

Author

Ramza Anuar ramza.nosp@m..anu.nosp@m.ar@tu.nosp@m.sas..nosp@m.my

Inter Driver File

Function Documentation

interDrv_memoryRegion_getAddress()

Error interDrv_memoryRegion_getAddress

(

RegionInfo *

region

)

interDrv_memoryRegion_getAddress.

Retrieves the memory region address.

Parameters

[out]

region

Pointer to a RegionInfo structure to store the retrieved address.

Returns

Error - Integrity status return code, If no error occurs during the operation of the function, it returns Success. Otherwise related error message is returned.

Low-Level Software Requirements (LLR)

Low-Level Requirement Specification: interDrv_memoryRegion_getAddress

Requirement ID	Parent HLR ID	Detailed Low-Level Requirement Statement (EARS Format)	Software Unit Reference	Verification Method	Status
LLR_INTERDRV_INTERDRV_MEMORYREGION_GETADDRESS_01	HLR_IO_36773	WHEN retrieving the memory region addresses via GetMemoryRegionAddresses() for region->memoryRegion succeeds, the interDrv_memoryRegion_getAddress() function SHALL calculate and store the base address offset into region->baseAddr.	interDrv.c:interDrv_memoryRegion_getAddress()	Test	Closed
LLR_INTERDRV_INTERDRV_MEMORYREGION_GETADDRESS_02	HLR_IO_36773	WHEN retrieving the memory region addresses via GetMemoryRegionAddresses() fails, the interDrv_memoryRegion_getAddress() function SHALL abort processing and return that driver failure status.	interDrv.c:interDrv_memoryRegion_getAddress()	Test	Closed
LLR_INTERDRV_INTERDRV_MEMORYREGION_GETADDRESS_03	HLR_IO_36773	WHEN region->hasMRStatus is equal to TRUE, the interDrv_memoryRegion_getAddress() function SHALL retrieve the status memory region address via GetMemoryRegionAddresses(), storing the address on success or returning that driver failure status on failure.	interDrv.c:interDrv_memoryRegion_getAddress()	Test	Closed
LLR_INTERDRV_INTERDRV_MEMORYREGION_GETADDRESS_04	HLR_IO_36773	WHEN all operational memory address mapping completes successfully, the interDrv_memoryRegion_getAddress() function SHALL return Success.	interDrv.c:interDrv_memoryRegion_getAddress()	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:

interDrv_Read32()

InterStatus interDrv_Read32	(	const Address	address,
		UInt32 *	data )

interDrv_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: interDrv_Read32

Requirement ID	Parent HLR ID	Detailed Low-Level Requirement Statement (EARS Format)	Software Unit Reference	Verification Method	Status
LLR_INTERDRV_INTERDRV_READ32_01	HLR_IO_36773	WHEN memory region validation fails (interDrv_isRegionRegistered() returns FALSE), the interDrv_Read32() function SHALL abort processing and return DRV_INVALID_PARAM.	interDrv.c:interDrv_Read32()	Test	Closed
LLR_INTERDRV_INTERDRV_READ32_02	HLR_IO_36773	WHEN address offset boundary validation fails (interDrv_isAddressValid() returns FALSE), the interDrv_Read32() function SHALL abort processing and return DRV_INVALID_PARAM.	interDrv.c:interDrv_Read32()	Test	Closed
LLR_INTERDRV_INTERDRV_READ32_03	HLR_IO_36773	WHEN memory region and offset validation pass, the interDrv_Read32() function SHALL read and return the 32-bit value at effective address (regionBaseAddress + offset) via memoryMap_Read32().	interDrv.c:interDrv_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:

interDrv_setAvailableRegion()

Error interDrv_setAvailableRegion

(

const void *

memRegion

)

interDrv_setAvailableRegion.

Set the available memory region.

Parameters

[in]

memRegion

The memory region object.

Returns

Error - Integrity status return code, If no error occurs during the operation of the function, it returns Success. Otherwise related error message is returned.

Low-Level Software Requirements (LLR)

Low-Level Requirement Specification: interDrv_setAvailableRegion

Requirement ID	Parent HLR ID	Detailed Low-Level Requirement Statement (EARS Format)	Software Unit Reference	Verification Method	Status
LLR_INTERDRV_INTERDRV_SETAVAILABLEREGION_01	HLR_IO_36773	WHEN registering the retrieved memory region address boundaries via interDrv_registerAvailableRegion() fails, the interDrv_setAvailableRegion() function SHALL abort processing and return Failure.	interDrv.c:interDrv_setAvailableRegion()	Test	Closed
LLR_INTERDRV_INTERDRV_SETAVAILABLEREGION_02	HLR_IO_36773	WHEN retrieving memory region addresses via GetMemoryRegionAddresses() fails, the interDrv_setAvailableRegion() function SHALL abort processing and return that driver failure status.	interDrv.c:interDrv_setAvailableRegion()	Test	Closed
LLR_INTERDRV_INTERDRV_SETAVAILABLEREGION_03	HLR_IO_36773	WHEN all operational address retrieval and memory region registration steps complete successfully, the interDrv_setAvailableRegion() function SHALL return Success.	interDrv.c:interDrv_setAvailableRegion()	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:

interDrv_Write32()

InterStatus interDrv_Write32	(	const Address	address,
		const UInt32	data )

interDrv_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: interDrv_Write32

Requirement ID	Parent HLR ID	Detailed Low-Level Requirement Statement (EARS Format)	Software Unit Reference	Verification Method	Status
LLR_INTERDRV_INTERDRV_WRITE32_01	HLR_IO_36773	WHEN memory region validation fails (interDrv_isRegionRegistered() returns FALSE), the interDrv_Write32() function SHALL abort processing and return DRV_INVALID_PARAM.	interDrv.c:interDrv_Write32()	Test	Closed
LLR_INTERDRV_INTERDRV_WRITE32_02	HLR_IO_36773	WHEN address offset boundary validation fails (interDrv_isAddressValid() returns FALSE), the interDrv_Write32() function SHALL abort processing and return DRV_INVALID_PARAM.	interDrv.c:interDrv_Write32()	Test	Closed
LLR_INTERDRV_INTERDRV_WRITE32_03	HLR_IO_36773	WHEN memory region and offset validation pass, the interDrv_Write32() function SHALL write the 32-bit data data to effective address (regionBaseAddress + offset) via memoryMap_Write32() and return DRV_SUCCESS.	interDrv.c:interDrv_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: