uefi_raw/protocol/network/
http.rs

1// SPDX-License-Identifier: MIT OR Apache-2.0
2
3use crate::{guid, Char16, Char8, Event, Guid, Ipv4Address, Ipv6Address, Status};
4use core::ffi::c_void;
5use core::fmt::{self, Debug, Formatter};
6use core::ptr;
7
8#[derive(Debug, Default)]
9#[repr(C)]
10pub struct HttpConfigData {
11    pub http_version: HttpVersion,
12    pub time_out_millisec: u32,
13    pub local_addr_is_ipv6: bool,
14    pub access_point: HttpAccessPoint,
15}
16
17newtype_enum! {
18    #[derive(Default)]
19    pub enum HttpVersion: i32 => {
20        HTTP_VERSION_10 = 0,
21        HTTP_VERSION_11 = 1,
22        HTTP_VERSION_UNSUPPORTED = 2,
23    }
24}
25
26#[derive(Clone, Copy, Debug, Default, Eq, PartialEq, Ord, PartialOrd, Hash)]
27#[repr(C)]
28pub struct HttpV4AccessPoint {
29    pub use_default_addr: bool,
30    pub local_address: Ipv4Address,
31    pub local_subnet: Ipv4Address,
32    pub local_port: u16,
33}
34
35#[derive(Clone, Copy, Debug, Default, Eq, PartialEq, Ord, PartialOrd, Hash)]
36#[repr(C)]
37pub struct HttpV6AccessPoint {
38    pub local_address: Ipv6Address,
39    pub local_port: u16,
40}
41
42#[repr(C)]
43pub union HttpAccessPoint {
44    pub ipv4_node: *const HttpV4AccessPoint,
45    pub ipv6_node: *const HttpV6AccessPoint,
46}
47
48impl Debug for HttpAccessPoint {
49    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
50        // This is a union type, so we can't access the internal data.
51        f.debug_struct("HttpAccessPoint").finish()
52    }
53}
54
55impl Default for HttpAccessPoint {
56    fn default() -> Self {
57        Self {
58            ipv4_node: ptr::null(),
59        }
60    }
61}
62
63#[derive(Debug)]
64#[repr(C)]
65pub struct HttpToken {
66    pub event: Event,
67    pub status: Status,
68    pub message: *mut HttpMessage,
69}
70
71impl Default for HttpToken {
72    fn default() -> Self {
73        Self {
74            event: ptr::null_mut(),
75            status: Status::SUCCESS,
76            message: ptr::null_mut(),
77        }
78    }
79}
80
81#[derive(Debug)]
82#[repr(C)]
83pub struct HttpMessage {
84    pub data: HttpRequestOrResponse,
85    pub header_count: usize,
86    pub header: *mut HttpHeader,
87    pub body_length: usize,
88    pub body: *mut c_void,
89}
90
91impl Default for HttpMessage {
92    fn default() -> Self {
93        Self {
94            data: HttpRequestOrResponse::default(),
95            header_count: 0,
96            header: ptr::null_mut(),
97            body_length: 0,
98            body: ptr::null_mut(),
99        }
100    }
101}
102
103#[derive(Debug)]
104#[repr(C)]
105pub struct HttpRequestData {
106    pub method: HttpMethod,
107    pub url: *const Char16,
108}
109
110impl Default for HttpRequestData {
111    fn default() -> Self {
112        Self {
113            method: HttpMethod::default(),
114            url: ptr::null(),
115        }
116    }
117}
118
119newtype_enum! {
120    #[derive(Default)]
121    pub enum HttpMethod: i32 => {
122        GET     = 0,
123        POST    = 1,
124        PATCH   = 2,
125        OPTIONS = 3,
126        CONNECT = 4,
127        HEAD    = 5,
128        PUT     = 6,
129        DELETE  = 7,
130        TRACE   = 8,
131        MAX     = 9,
132    }
133}
134
135#[derive(Debug, Default)]
136#[repr(C)]
137pub struct HttpResponseData {
138    pub status_code: HttpStatusCode,
139}
140
141#[repr(C)]
142pub union HttpRequestOrResponse {
143    pub request: *const HttpRequestData,
144    pub response: *const HttpResponseData,
145}
146
147impl Debug for HttpRequestOrResponse {
148    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
149        // This is a union type, so we can't access the internal data.
150        f.debug_struct("RequestOrResponse").finish()
151    }
152}
153
154impl Default for HttpRequestOrResponse {
155    fn default() -> Self {
156        Self {
157            request: ptr::null(),
158        }
159    }
160}
161
162#[derive(Clone, Debug)]
163#[repr(C)]
164pub struct HttpHeader {
165    pub field_name: *const Char8,
166    pub field_value: *const Char8,
167}
168
169impl Default for HttpHeader {
170    fn default() -> Self {
171        Self {
172            field_name: ptr::null(),
173            field_value: ptr::null(),
174        }
175    }
176}
177
178newtype_enum! {
179    #[derive(Default)]
180    pub enum HttpStatusCode: i32 => {
181        STATUS_UNSUPPORTED = 0,
182        STATUS_100_CONTINUE = 1,
183        STATUS_101_SWITCHING_PROTOCOLS = 2,
184        STATUS_200_OK = 3,
185        STATUS_201_CREATED = 4,
186        STATUS_202_ACCEPTED = 5,
187        STATUS_203_NON_AUTHORITATIVE_INFORMATION = 6,
188        STATUS_204_NO_CONTENT = 7,
189        STATUS_205_RESET_CONTENT = 8,
190        STATUS_206_PARTIAL_CONTENT = 9,
191        STATUS_300_MULTIPLE_CHOICES = 10,
192        STATUS_301_MOVED_PERMANENTLY = 11,
193        STATUS_302_FOUND = 12,
194        STATUS_303_SEE_OTHER = 13,
195        STATUS_304_NOT_MODIFIED = 14,
196        STATUS_305_USE_PROXY = 15,
197        STATUS_307_TEMPORARY_REDIRECT = 16,
198        STATUS_400_BAD_REQUEST = 17,
199        STATUS_401_UNAUTHORIZED = 18,
200        STATUS_402_PAYMENT_REQUIRED = 19,
201        STATUS_403_FORBIDDEN = 20,
202        STATUS_404_NOT_FOUND = 21,
203        STATUS_405_METHOD_NOT_ALLOWED = 22,
204        STATUS_406_NOT_ACCEPTABLE = 23,
205        STATUS_407_PROXY_AUTHENTICATION_REQUIRED = 24,
206        STATUS_408_REQUEST_TIME_OUT = 25,
207        STATUS_409_CONFLICT = 26,
208        STATUS_410_GONE = 27,
209        STATUS_411_LENGTH_REQUIRED = 28,
210        STATUS_412_PRECONDITION_FAILED = 29,
211        STATUS_413_REQUEST_ENTITY_TOO_LARGE = 30,
212        STATUS_414_REQUEST_URI_TOO_LARGE = 31,
213        STATUS_415_UNSUPPORTED_MEDIA_TYPE = 32,
214        STATUS_416_REQUESTED_RANGE_NOT_SATISFIED = 33,
215        STATUS_417_EXPECTATION_FAILED = 34,
216        STATUS_500_INTERNAL_SERVER_ERROR = 35,
217        STATUS_501_NOT_IMPLEMENTED = 36,
218        STATUS_502_BAD_GATEWAY = 37,
219        STATUS_503_SERVICE_UNAVAILABLE = 38,
220        STATUS_504_GATEWAY_TIME_OUT = 39,
221        STATUS_505_VERSION_NOT_SUPPORTED = 40,
222        STATUS_308_PERMANENT_REDIRECT = 41,
223    }
224}
225
226#[derive(Debug)]
227#[repr(C)]
228pub struct HttpProtocol {
229    pub get_mode_data:
230        unsafe extern "efiapi" fn(this: *const Self, config_data: *mut HttpConfigData) -> Status,
231    pub configure:
232        unsafe extern "efiapi" fn(this: *mut Self, config_data: *const HttpConfigData) -> Status,
233    pub request: unsafe extern "efiapi" fn(this: *mut Self, token: *mut HttpToken) -> Status,
234    pub cancel: unsafe extern "efiapi" fn(this: *mut Self, token: *mut HttpToken) -> Status,
235    pub response: unsafe extern "efiapi" fn(this: *mut Self, token: *mut HttpToken) -> Status,
236    pub poll: unsafe extern "efiapi" fn(this: *mut Self) -> Status,
237}
238
239impl HttpProtocol {
240    pub const GUID: Guid = guid!("7a59b29b-910b-4171-8242-a85a0df25b5b");
241    pub const SERVICE_BINDING_GUID: Guid = guid!("bdc8e6af-d9bc-4379-a72a-e0c4e75dae1c");
242}
uefi_raw/protocol/network/http.rs

uefi_raw/protocol/network/
http.rs
