1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
/** @file
Copyright (c) 2018, Intel Corporation. All rights reserved.<BR>
This program and the accompanying materials are licensed and made available under
the terms and conditions of the BSD License that accompanies this distribution.
The full text of the license may be found at
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef __USRA_ACCESS_API_H__
#define __USRA_ACCESS_API_H__
#include <UsraAccessType.h>
//////////////////////////////////////////////////////////////////////////
//
// USRA Silicon Access Library
//
//////////////////////////////////////////////////////////////////////////
/**
This API Perform 8-bit, 16-bit, 32-bit or 64-bit silicon register read operations.
It transfers data from a register into a naturally aligned data buffer.
@param[in] Address A pointer of the address of the USRA Address Structure to be read out
@param[in] Buffer A pointer of buffer for the value read from the register
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
EFIAPI
RegisterRead (
IN USRA_ADDRESS *Address,
OUT VOID *Buffer
);
/**
This API Perform 8-bit, 16-bit, 32-bit or 64-bit silicon register write operations.
It transfers data from a naturally aligned data buffer into a silicon register.
@param[in] Address A pointer of the address of the USRA Address Structure to be written
@param[in] Buffer A pointer of buffer for the value write to the register
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
EFIAPI
RegisterWrite (
IN USRA_ADDRESS *Address,
IN VOID *Buffer
);
/**
This API Perform 8-bit, 16-bit, 32-bit or 64-bit silicon register AND then OR operations. It read data from a
register, And it with the AndBuffer, then Or it with the OrBuffer, and write the result back to the register
@param[in] Address A pointer of the address of the silicon register to be written
@param[in] AndBuffer A pointer of buffer for the value used for AND operation
A NULL pointer means no AND operation. RegisterModify() equivalents to RegisterOr()
@param[in] OrBuffer A pointer of buffer for the value used for OR operation
A NULL pointer means no OR operation. RegisterModify() equivalents to RegisterAnd()
@retval RETURN_SUCCESS The function completed successfully.
**/
RETURN_STATUS
EFIAPI
RegisterModify (
IN USRA_ADDRESS *Address,
IN VOID *AndBuffer,
IN VOID *OrBuffer
);
/**
This API get the flat address from the given USRA Address.
@param[in] Address A pointer of the address of the USRA Address Structure to be read out
@retval The flat address
**/
INTN
EFIAPI
GetRegisterAddress (
IN USRA_ADDRESS *Address
);
#endif
|
