| 1 | /** @file
|
|---|
| 2 | This header file declares Trace Hub related top level APIs.
|
|---|
| 3 |
|
|---|
| 4 | Copyright (c) 2023, Intel Corporation. All rights reserved.<BR>
|
|---|
| 5 |
|
|---|
| 6 | SPDX-License-Identifier: BSD-2-Clause-Patent
|
|---|
| 7 |
|
|---|
| 8 | **/
|
|---|
| 9 |
|
|---|
| 10 | #ifndef TRACE_HUB_DEBUG_SYST_LIB_H_
|
|---|
| 11 | #define TRACE_HUB_DEBUG_SYST_LIB_H_
|
|---|
| 12 |
|
|---|
| 13 | typedef enum {
|
|---|
| 14 | SeverityNone = 0,
|
|---|
| 15 | SeverityFatal = 1,
|
|---|
| 16 | SeverityError = 2,
|
|---|
| 17 | SeverityWarning = 3,
|
|---|
| 18 | SeverityNormal = 4,
|
|---|
| 19 | SeverityUser1 = 5,
|
|---|
| 20 | SeverityUser2 = 6,
|
|---|
| 21 | SeverityUser3 = 7,
|
|---|
| 22 | SeverityMax
|
|---|
| 23 | } TRACE_HUB_SEVERITY_TYPE;
|
|---|
| 24 |
|
|---|
| 25 | /**
|
|---|
| 26 | Write debug string to specified Trace Hub MMIO address.
|
|---|
| 27 |
|
|---|
| 28 | @param[in] SeverityType Severity type of input message.
|
|---|
| 29 | @param[in] Buffer A pointer to the data buffer.
|
|---|
| 30 | @param[in] NumberOfBytes The size of data buffer.
|
|---|
| 31 |
|
|---|
| 32 | @retval RETURN_SUCCESS Data was written to Trace Hub.
|
|---|
| 33 | @retval Other Failed to output Trace Hub message.
|
|---|
| 34 | **/
|
|---|
| 35 | RETURN_STATUS
|
|---|
| 36 | EFIAPI
|
|---|
| 37 | TraceHubSysTDebugWrite (
|
|---|
| 38 | IN TRACE_HUB_SEVERITY_TYPE SeverityType,
|
|---|
| 39 | IN UINT8 *Buffer,
|
|---|
| 40 | IN UINTN NumberOfBytes
|
|---|
| 41 | );
|
|---|
| 42 |
|
|---|
| 43 | /**
|
|---|
| 44 | Write catalog status code message to specified Trace Hub MMIO address.
|
|---|
| 45 |
|
|---|
| 46 | @param[in] SeverityType Severity type of input message.
|
|---|
| 47 | @param[in] Id Catalog ID.
|
|---|
| 48 | @param[in] Guid Driver Guid.
|
|---|
| 49 |
|
|---|
| 50 | @retval RETURN_SUCCESS Data was written to Trace Hub.
|
|---|
| 51 | @retval Other Failed to output Trace Hub message.
|
|---|
| 52 | **/
|
|---|
| 53 | RETURN_STATUS
|
|---|
| 54 | EFIAPI
|
|---|
| 55 | TraceHubSysTWriteCataLog64StatusCode (
|
|---|
| 56 | IN TRACE_HUB_SEVERITY_TYPE SeverityType,
|
|---|
| 57 | IN UINT64 Id,
|
|---|
| 58 | IN GUID *Guid
|
|---|
| 59 | );
|
|---|
| 60 |
|
|---|
| 61 | /**
|
|---|
| 62 | Write catalog message to specified Trace Hub MMIO address.
|
|---|
| 63 |
|
|---|
| 64 | @param[in] SeverityType Severity type of input message.
|
|---|
| 65 | @param[in] Id Catalog ID.
|
|---|
| 66 | @param[in] NumberOfParams Number of entries in argument list.
|
|---|
| 67 | @param[in] ... Catalog message parameters.
|
|---|
| 68 |
|
|---|
| 69 | @retval RETURN_SUCCESS Data was written to Trace Hub.
|
|---|
| 70 | @retval Other Failed to output Trace Hub message.
|
|---|
| 71 | **/
|
|---|
| 72 | RETURN_STATUS
|
|---|
| 73 | EFIAPI
|
|---|
| 74 | TraceHubSysTWriteCataLog64 (
|
|---|
| 75 | IN TRACE_HUB_SEVERITY_TYPE SeverityType,
|
|---|
| 76 | IN UINT64 Id,
|
|---|
| 77 | IN UINTN NumberOfParams,
|
|---|
| 78 | ...
|
|---|
| 79 | );
|
|---|
| 80 |
|
|---|
| 81 | #endif // TRACE_HUB_DEBUG_SYST_LIB_H_
|
|---|
