Skip to content

Commit 865b154

Browse files
callumfarecallumfare
committed
Fix style
1 parent 1c0a7b2 commit 865b154

File tree

14 files changed

+460
-465
lines changed

14 files changed

+460
-465
lines changed

‎offload/new-api/API/Common.td‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@ def : Struct {
7272
let name = "offload_error_struct_t";
7373
let desc = "Details of the error condition returned by an API call";
7474
let members = [
75-
StructMember<"offload_errc_t", "code", "The error code">,
76-
StructMember<"const char*", "details", "String containing error details">
75+
StructMember<"offload_errc_t", "Code", "The error code">,
76+
StructMember<"const char*", "Details", "String containing error details">
7777
];
7878
}
7979

‎offload/new-api/API/Device.td‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ def : Function {
3838
let name = "offloadDeviceGetCount";
3939
let desc = "Retrieves the number of available devices within a platform";
4040
let params = [
41-
Param<"offload_platform_handle_t", "hPlatform", "handle of the platform instance", PARAM_IN>,
42-
Param<"uint32_t*", "pNumDevices", "pointer to the number of devices.", PARAM_OUT>
41+
Param<"offload_platform_handle_t", "Platform", "handle of the platform instance", PARAM_IN>,
42+
Param<"uint32_t*", "NumDevices", "pointer to the number of devices.", PARAM_OUT>
4343
];
4444
let returns = [];
4545
}
@@ -52,9 +52,9 @@ def : Function {
5252
"The application may call this function from simultaneous threads, the implementation must be thread-safe"
5353
];
5454
let params = [
55-
Param<"offload_platform_handle_t", "hPlatform", "handle of the platform instance", PARAM_IN>,
55+
Param<"offload_platform_handle_t", "Platform", "handle of the platform instance", PARAM_IN>,
5656
Param<"uint32_t", "NumEntries", "the number of devices to be added to phDevices, which must be greater than zero", PARAM_IN>,
57-
RangedParam<"offload_device_handle_t*", "phDevices", "Array of device handles. "
57+
RangedParam<"offload_device_handle_t*", "Devices", "Array of device handles. "
5858
"If NumEntries is less than the number of devices available, then this function shall only retrieve that number of devices.", PARAM_OUT,
5959
Range<"0", "NumEntries">>
6060
];
@@ -73,20 +73,20 @@ def : Function {
7373
"The implementation of this function should be lock-free."
7474
];
7575
let params = [
76-
Param<"offload_device_handle_t", "hDevice", "handle of the device instance", PARAM_IN>,
77-
Param<"offload_device_info_t", "propName", "type of the info to retrieve", PARAM_IN>,
78-
Param<"size_t", "propSize", "the number of bytes pointed to by pPropValue.", PARAM_IN>,
79-
TypeTaggedParam<"void*", "pPropValue", "array of bytes holding the info. If propSize is not equal to or greater than the real "
76+
Param<"offload_device_handle_t", "Device", "handle of the device instance", PARAM_IN>,
77+
Param<"offload_device_info_t", "PropName", "type of the info to retrieve", PARAM_IN>,
78+
Param<"size_t", "PropSize", "the number of bytes pointed to by PropValue.", PARAM_IN>,
79+
TypeTaggedParam<"void*", "PropValue", "array of bytes holding the info. If PropSize is not equal to or greater than the real "
8080
"number of bytes needed to return the info then the OFFLOAD_ERRC_INVALID_SIZE error is returned and "
81-
"pPropValue is not used.", PARAM_OUT, TypeInfo<"propName" , "propSize">>
81+
"PropValue is not used.", PARAM_OUT, TypeInfo<"PropName" , "PropSize">>
8282
];
8383
let returns = [
8484
Return<"OFFLOAD_ERRC_UNSUPPORTED_ENUMERATION", [
85-
"If `propName` is not supported by the device."
85+
"If `PropName` is not supported by the device."
8686
]>,
8787
Return<"OFFLOAD_ERRC_INVALID_SIZE", [
88-
"`propSize == 0`",
89-
"If `propSize` is less than the real number of bytes needed to return the info."
88+
"`PropSize == 0`",
89+
"If `PropSize` is less than the real number of bytes needed to return the info."
9090
]>,
9191
Return<"OFFLOAD_ERRC_INVALID_DEVICE">
9292
];
@@ -100,13 +100,13 @@ def : Function {
100100
"The implementation of this function should be lock-free."
101101
];
102102
let params = [
103-
Param<"offload_device_handle_t", "hDevice", "handle of the device instance", PARAM_IN>,
104-
Param<"offload_device_info_t", "propName", "type of the info to retrieve", PARAM_IN>,
105-
Param<"size_t*", "pPropSizeRet", "pointer to the number of bytes required to store the query", PARAM_OUT>
103+
Param<"offload_device_handle_t", "Device", "handle of the device instance", PARAM_IN>,
104+
Param<"offload_device_info_t", "PropName", "type of the info to retrieve", PARAM_IN>,
105+
Param<"size_t*", "PropSizeRet", "pointer to the number of bytes required to store the query", PARAM_OUT>
106106
];
107107
let returns = [
108108
Return<"OFFLOAD_ERRC_UNSUPPORTED_ENUMERATION", [
109-
"If `propName` is not supported by the device."
109+
"If `PropName` is not supported by the device."
110110
]>,
111111
Return<"OFFLOAD_ERRC_INVALID_DEVICE">
112112
];

‎offload/new-api/API/Platform.td‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ def : Function {
1717
];
1818
let params = [
1919
Param<"uint32_t", "NumEntries",
20-
"The number of platforms to be added to phPlatforms. NumEntries must be "
20+
"The number of platforms to be added to Platforms. NumEntries must be "
2121
"greater than zero.",
2222
PARAM_IN>,
23-
RangedParam<"offload_platform_handle_t*", "phPlatforms",
23+
RangedParam<"offload_platform_handle_t*", "Platforms",
2424
"Array of handle of platforms. If NumEntries is less than the number of "
2525
"platforms available, then offloadPlatformGet shall only retrieve that "
2626
"number of platforms.",
@@ -38,7 +38,7 @@ def : Function {
3838
let desc = "Retrieves the number of available platforms";
3939
let params = [
4040
Param<"uint32_t*",
41-
"pNumPlatforms", "returns the total number of platforms available.",
41+
"NumPlatforms", "returns the total number of platforms available.",
4242
PARAM_OUT>
4343
];
4444
let returns = [];
@@ -52,7 +52,7 @@ def : Enum {
5252
TaggedEtor<"NAME", "char[]", "The string denoting name of the platform. The size of the info needs to be dynamically queried.">,
5353
TaggedEtor<"VENDOR_NAME", "char[]","The string denoting name of the vendor of the platform. The size of the info needs to be dynamically queried.">,
5454
TaggedEtor<"VERSION", "char[]", "The string denoting the version of the platform. The size of the info needs to be dynamically queried.">,
55-
TaggedEtor<"BACKEND", "offload_platform_backend_t", "The backend of the platform. Identifies the native backend adapter implementing this platform.">
55+
TaggedEtor<"BACKEND", "offload_platform_backend_t", "The native backend of the platform.">
5656
];
5757
}
5858

@@ -76,21 +76,21 @@ def : Function {
7676
"The implementation of this function should be lock-free."
7777
];
7878
let params = [
79-
Param<"offload_platform_handle_t", "hPlatform", "handle of the platform", PARAM_IN>,
80-
Param<"offload_platform_info_t", "propName", "type of the info to retrieve", PARAM_IN>,
81-
Param<"size_t", "propSize", "the number of bytes pointed to by pPlatformInfo.", PARAM_IN>,
82-
TypeTaggedParam<"void*", "pPropValue", "array of bytes holding the info. "
79+
Param<"offload_platform_handle_t", "Platform", "handle of the platform", PARAM_IN>,
80+
Param<"offload_platform_info_t", "PropName", "type of the info to retrieve", PARAM_IN>,
81+
Param<"size_t", "PropSize", "the number of bytes pointed to by pPlatformInfo.", PARAM_IN>,
82+
TypeTaggedParam<"void*", "PropValue", "array of bytes holding the info. "
8383
"If Size is not equal to or greater to the real number of bytes needed to return the info "
8484
"then the OFFLOAD_ERRC_INVALID_SIZE error is returned and pPlatformInfo is not used.", PARAM_OUT,
85-
TypeInfo<"propName" , "propSize">>
85+
TypeInfo<"PropName" , "PropSize">>
8686
];
8787
let returns = [
8888
Return<"OFFLOAD_ERRC_UNSUPPORTED_ENUMERATION", [
89-
"If `propName` is not supported by the platform."
89+
"If `PropName` is not supported by the platform."
9090
]>,
9191
Return<"OFFLOAD_ERRC_INVALID_SIZE", [
92-
"`propSize == 0`",
93-
"If `propSize` is less than the real number of bytes needed to return the info."
92+
"`PropSize == 0`",
93+
"If `PropSize` is less than the real number of bytes needed to return the info."
9494
]>,
9595
Return<"OFFLOAD_ERRC_INVALID_PLATFORM">
9696
];
@@ -104,13 +104,13 @@ def : Function {
104104
"The implementation of this function should be lock-free."
105105
];
106106
let params = [
107-
Param<"offload_platform_handle_t", "hPlatform", "handle of the platform", PARAM_IN>,
108-
Param<"offload_platform_info_t", "propName", "type of the info to query", PARAM_IN>,
109-
Param<"size_t*", "pPropSizeRet", "pointer to the number of bytes required to store the query", PARAM_OUT>
107+
Param<"offload_platform_handle_t", "Platform", "handle of the platform", PARAM_IN>,
108+
Param<"offload_platform_info_t", "PropName", "type of the info to query", PARAM_IN>,
109+
Param<"size_t*", "PropSizeRet", "pointer to the number of bytes required to store the query", PARAM_OUT>
110110
];
111111
let returns = [
112112
Return<"OFFLOAD_ERRC_UNSUPPORTED_ENUMERATION", [
113-
"If `propName` is not supported by the platform."
113+
"If `PropName` is not supported by the platform."
114114
]>,
115115
Return<"OFFLOAD_ERRC_INVALID_PLATFORM">
116116
];

0 commit comments

Comments
 (0)