Skip to content

Commit e4aa00a

Browse files
committed
Pad out asm function docs.
1 parent e43c456 commit e4aa00a

File tree

2 files changed

+12
-0
lines changed

2 files changed

+12
-0
lines changed

cortex-a-rt/src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -368,29 +368,35 @@
368368
//! initialization routines, so if our start-up routine doesn't work for you,
369369
//! supply your own `_start` function (but feel free to call our
370370
//! `_default_start` as part of it).
371+
//!
371372
//! * `_asm_undefined_handler` - a naked function to call when an Undefined
372373
//! Exception occurs. Our linker script PROVIDEs a default function at
373374
//! `_asm_default_undefined_handler` but you can override it. The provided
374375
//! default handler will call `_undefined_handler`, saving state as required.
376+
//!
375377
//! * `_asm_svc_handler` - a naked function to call when an SVC Exception
376378
//! occurs. Our linker script PROVIDEs a default function at
377379
//! `_asm_default_svc_handler` but you can override it. The provided default
378380
//! handler will call `_svc_handler`, saving state as required.
381+
//!
379382
//! * `_asm_prefetch_abort_handler` - a naked function to call when a Prefetch
380383
//! Exception occurs. Our linker script PROVIDEs a default function at
381384
//! `_asm_default_prefetch_abort_handler` but you can override it. The
382385
//! provided default handler will call `_prefetch_abort_handler`, saving state
383386
//! as required. Note that Prefetch Abort Exceptions are handled in Abort
384387
//! Mode, Monitor Mode or Hyp Mode, depending on CPU configuration. There is
385388
//! no Prefetch Abort mode, so there is no Prefetch Abort Mode stack.
389+
//!
386390
//! * `_asm_data_abort_handler` - a naked function to call when an Abort
387391
//! Exception occurs. Our linker script PROVIDEs a default function at
388392
//! `_asm_default_data_abort_handler` but you can override it. The provided
389393
//! default handler will call `_data_abort_handler`, saving state as required.
394+
//!
390395
//! * `_asm_irq_handler` - a naked function to call when an Undefined Exception
391396
//! occurs. Our linker script PROVIDEs a default function at
392397
//! `_asm_default_irq_handler` but you can override it. The provided default
393398
//! handler will call `_irq_handler`, saving state as required.
399+
//!
394400
//! * `_asm_fiq_handler` - a naked function to call when a Fast Interrupt
395401
//! Request (FIQ) occurs. Our linker script PROVIDEs a default function at
396402
//! `_asm_default_fiq_handler` but you can override it. The provided default

cortex-r-rt/src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -367,29 +367,35 @@
367367
//! initialization routines, so if our start-up routine doesn't work for you,
368368
//! supply your own `_start` function (but feel free to call our
369369
//! `_default_start` as part of it).
370+
//!
370371
//! * `_asm_undefined_handler` - a naked function to call when an Undefined
371372
//! Exception occurs. Our linker script PROVIDEs a default function at
372373
//! `_asm_default_undefined_handler` but you can override it. The provided
373374
//! default handler will call `_undefined_handler`, saving state as required.
375+
//!
374376
//! * `_asm_svc_handler` - a naked function to call when an SVC Exception
375377
//! occurs. Our linker script PROVIDEs a default function at
376378
//! `_asm_default_svc_handler` but you can override it. The provided default
377379
//! handler will call `_svc_handler`, saving state as required.
380+
//!
378381
//! * `_asm_prefetch_abort_handler` - a naked function to call when a Prefetch
379382
//! Exception occurs. Our linker script PROVIDEs a default function at
380383
//! `_asm_default_prefetch_abort_handler` but you can override it. The
381384
//! provided default handler will call `_prefetch_abort_handler`, saving state
382385
//! as required. Note that Prefetch Abort Exceptions are handled in Abort
383386
//! Mode, Monitor Mode or Hyp Mode, depending on CPU configuration. There is
384387
//! no Prefetch Abort mode, so there is no Prefetch Abort Mode stack.
388+
//!
385389
//! * `_asm_data_abort_handler` - a naked function to call when an Abort
386390
//! Exception occurs. Our linker script PROVIDEs a default function at
387391
//! `_asm_default_data_abort_handler` but you can override it. The provided
388392
//! default handler will call `_data_abort_handler`, saving state as required.
393+
//!
389394
//! * `_asm_irq_handler` - a naked function to call when an Undefined Exception
390395
//! occurs. Our linker script PROVIDEs a default function at
391396
//! `_asm_default_irq_handler` but you can override it. The provided default
392397
//! handler will call `_irq_handler`, saving state as required.
398+
//!
393399
//! * `_asm_fiq_handler` - a naked function to call when a Fast Interrupt
394400
//! Request (FIQ) occurs. Our linker script PROVIDEs a default function at
395401
//! `_asm_default_fiq_handler` but you can override it. The provided default

0 commit comments

Comments
 (0)