Zig 0.17.0-dev (Split by item) This is an example of documentation generated by
ZigDoc , an alternative to Zig's built-in
Auto Doc feature. See also
examples in other modes/formats . The project being documented here (as the example) is the Zig standard library.
std › debug › cpu_context › Aarch64 › dwarfRegisterBytes Public Function dwarfRegisterBytes Doc Source Public Function std.debug.cpu_context.Aarch64.dwarfRegisterBytes
pub fn dwarfRegisterBytes (ctx : *Aarch64 register_num : u16 ) DwarfRegisterError u8 Params Errors InvalidRegister UnsupportedRegister File debug/cpu_context.zig: 285
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308 pub fn dwarfRegisterBytes (ctx : *Aarch64 register_num : u16 ) DwarfRegisterError u8 {
// DWARF for the Arm(r) 64-bit Architecture (AArch64) § 4.1 "DWARF register names"
switch (register_num ) {
0 ...30 => return @ptrCast (&ctx .x [register_num ]),
31 => return @ptrCast (&ctx .sp ),
32 => return @ptrCast (&ctx .pc ),
33 => return error .UnsupportedRegister , // ELR_mode
34 => return error .UnsupportedRegister , // RA_SIGN_STATE
35 => return error .UnsupportedRegister , // TPIDRRO_ELO
36 => return error .UnsupportedRegister , // TPIDR_ELO
37 => return error .UnsupportedRegister , // TPIDR_EL1
38 => return error .UnsupportedRegister , // TPIDR_EL2
39 => return error .UnsupportedRegister , // TPIDR_EL3
40 ...45 => return error .UnsupportedRegister , // Reserved
46 => return error .UnsupportedRegister , // VG
47 => return error .UnsupportedRegister , // FFR
48 ...63 => return error .UnsupportedRegister , // P0 - P15
64 ...95 => return error .UnsupportedRegister , // V0 - V31
96 ...127 => return error .UnsupportedRegister , // Z0 - Z31
else => return error .InvalidRegister ,
}
}