- cap_access
- 1. Overview
- 2. Core Architecture
- 2.1. Capability System
- 2.2. Object Protection with WithCap
- 2.3. Access Control Methods
- 3. Usage Guide
- 4. ArceOS Integration
- 5. Development Guide
- 5.1. Build System and CI
- 5.2. Multi-Platform Support
- kspin
- 6. Overview
- 6.1. Project Structure and Dependencies
- 7. Spinlock Types and Public API
- 7.1. SpinRaw
- 7.2. SpinNoPreempt
- 7.3. SpinNoIrq
- 7.4. Usage Guidelines and Safety
- 8. Core Implementation Architecture
- 8.1. BaseSpinLock and BaseSpinLockGuard
- 8.2. BaseGuard Trait System
- 8.3. SMP vs Single-Core Implementation
- 8.4. Memory Ordering and Atomic Operations
- 9. Development and Building
- 9.1. Build System and Feature Flags
- 9.2. Testing and CI Pipeline
- 9.3. Development Environment Setup
- kernel_guard
- 10. Overview
- 11. Core Architecture
- 11.1. RAII Guards
- 11.2. Trait System
- 12. Multi-Architecture Support
- 12.1. Architecture Abstraction Layer
- 12.2. x86/x86_64 Implementation
- 12.3. RISC-V Implementation
- 12.4. AArch64 Implementation
- 12.5. LoongArch64 Implementation
- 13. Integration Guide
- 13.1. Feature Configuration
- 13.2. Implementing KernelGuardIf
- 14. Development
- 14.1. Build System and CI
- 14.2. Development Environment
- timer_list
- 15. Overview
- 16. Core API Reference
- 16.1. TimerList Data Structure
- 16.2. TimerEvent System
- 17. Usage Guide and Examples
- 18. Development Workflow
- 18.1. Building and Testing
- 18.2. Project Structure
- slab_allocator
- 19. Overview
- 20. Getting Started
- 21. Core Architecture
- 21.1. Heap Allocator Design
- 21.2. Slab Implementation
- 22. API Reference
- 23. Testing and Validation
- 24. Development Workflow
- cpumask
- 25. Overview
- 26. API Reference
- 26.1. Construction and Conversion Methods
- 26.2. Query and Inspection Operations
- 26.3. Modification and Iteration
- 26.4. Bitwise Operations and Traits
- 27. Architecture and Design
- 28. Usage Guide and Examples
- 29. Development and Contribution
- axcpu
- 30. Overview
- 31. x86_64 Architecture
- 31.1. x86_64 Context Management
- 31.2. x86_64 Trap and Exception Handling
- 31.3. x86_64 System Calls
- 31.4. x86_64 System Initialization
- 32. AArch64 Architecture
- 32.1. AArch64 Context Management
- 32.2. AArch64 Trap and Exception Handling
- 32.3. AArch64 System Initialization
- 33. RISC-V Architecture
- 33.1. RISC-V Context Management
- 33.2. RISC-V Trap and Exception Handling
- 33.3. RISC-V System Initialization
- 34. LoongArch64 Architecture
- 34.1. LoongArch64 Context Management
- 34.2. LoongArch64 Assembly Operations
- 34.3. LoongArch64 System Initialization
- 35. Cross-Architecture Features
- 35.1. User Space Support
- 35.2. Core Trap Handling Framework
- 36. Development and Build Configuration
- 36.1. Dependencies and Package Structure
- 36.2. Toolchain Configuration
- axfs_crates
- 37. Overview
- 37.1. Repository Structure
- 37.2. Development and Contribution
- 38. File System Architecture
- 38.1. Virtual File System Interface (axfs_vfs)
- 39. Device File System (axfs_devfs)
- 39.1. Directory Structure
- 39.2. Null Device
- 39.3. Zero Device
- 39.4. Usage Examples
- 40. RAM File System (axfs_ramfs)
- scheduler
- 41. Overview
- 42. Core Architecture
- 43. Scheduler Implementations
- 43.1. FIFO Scheduler
- 43.2. Completely Fair Scheduler (CFS)
- 43.3. Round Robin Scheduler
- 43.4. Scheduler Comparison
- 44. Testing Framework
- 45. Development Guide
- tuple_for_each
- 46. Overview
- 46.1. Project Structure
- 47. Getting Started
- 47.1. Basic Usage
- 47.2. Generated Functionality
- 48. Implementation Guide
- 48.1. Derive Macro Processing
- 48.2. Code Generation Pipeline
- 49. Development
- 49.1. Testing
- 49.2. CI/CD Pipeline
- 50. API Reference
- 50.1. TupleForEach Derive Macro
- 50.2. Generated Macros
- 50.3. Generated Methods
- allocator
- 51. Overview
- 52. Architecture and Design
- 53. Allocator Implementations
- 53.1. Bitmap Page Allocator
- 53.2. Buddy System Allocator
- 53.3. Slab Allocator
- 53.4. TLSF Allocator
- 54. Usage and Configuration
- 55. Testing and Benchmarks
- 55.1. Integration Tests
- 55.2. Performance Benchmarks
- 56. Development and Contributing
- axmm_crates
- 57. Overview
- 57.1. System Architecture
- 58. memory_addr Crate
- 58.1. Address Types and Operations
- 58.2. Address Ranges
- 58.3. Page Iteration
- 59. memory_set Crate
- 59.1. MemorySet Core
- 59.2. MemoryArea
- 59.3. MappingBackend
- 59.4. Usage Examples and Testing
- 60. Development Guide
- arm_pl031
- 61. Overview
- 61.1. Project Purpose and Scope
- 61.2. System Architecture
- 62. Getting Started
- 62.1. Installation and Dependencies
- 62.2. Basic Usage and Examples
- 63. Core Driver Implementation
- 63.1. Driver Architecture and Design
- 63.2. Hardware Interface and MMIO
- 63.3. Register Operations
- 63.4. Interrupt Handling
- 63.5. Memory Safety and Concurrency
- 64. Features and Extensions
- 64.1. Chrono Integration
- 64.2. Feature Configuration
- 65. Development and Contributing
- 65.1. Building and Testing
- 65.2. API Evolution and Changelog
- 65.3. Development Environment
- crate_interface
- 66. Overview
- 67. Getting Started
- 68. Macro Reference
- 68.1. def_interface Macro
- 68.2. impl_interface Macro
- 68.3. call_interface Macro
- 69. Architecture and Internals
- 70. Development Guide
- 70.1. Testing
- 70.2. CI/CD Pipeline
- 70.3. Project Structure
- lazyinit
- 71. Overview
- 72. LazyInit Implementation
- 72.1. API Reference
- 72.2. Thread Safety & Memory Model
- 72.3. Usage Patterns & Examples
- 73. Project Configuration
- 74. Development & Contributing
- 74.1. CI/CD Pipeline
- 74.2. Development Environment Setup
- linked_list_r4l
- 75. Overview
- 76. Quick Start Guide
- 77. Architecture Overview
- 78. API Reference
- 78.1. User-Friendly API
- 78.2. Advanced API
- 78.3. Low-Level API
- 79. Core Concepts
- 79.1. Memory Management
- 79.2. Thread Safety
- 80. Development Guide
- arm_pl011
- 81. Overview
- 81.1. Architecture
- 81.2. Getting Started
- 82. Core Implementation
- 82.1. Register Definitions
- 82.2. UART Operations
- 83. API Reference
- 83.1. Pl011Uart Methods
- 83.2. Thread Safety and Memory Safety
- 84. Development
- 84.1. Building and Testing
- 84.2. CI/CD Pipeline
- 85. Hardware Reference
- handler_table
- 86. Introduction
- 86.1. ArceOS Integration
- 86.2. Lock-free Design Benefits
- 87. User Guide
- 87.1. API Reference
- 87.2. Usage Examples
- 88. Implementation Details
- 88.1. Atomic Operations
- 88.2. Memory Layout and Safety
- 89. Development Guide
- 89.1. Building and Testing
- 89.2. CI/CD Pipeline
- memory_set
- 90. Overview
- 90.1. Core Concepts
- 90.2. System Architecture
- 91. Implementation Details
- 91.1. MemoryArea and MappingBackend
- 91.2. MemorySet Collection Management
- 91.3. Public API and Error Handling
- 92. Usage and Examples
- 92.1. Basic Usage Patterns
- 92.2. Advanced Examples and Testing
- 93. Development and Project Setup
- 93.1. Dependencies and Configuration
- 93.2. Development Workflow
- int_ratio
- 94. Overview
- 95. Ratio Type Implementation
- 95.1. Internal Architecture
- 95.2. API Reference
- 95.3. Mathematical Foundation
- 96. Usage Guide
- 97. Development Guide
- flatten_objects
- 98. Overview
- 98.1. Project Structure and Dependencies
- 98.2. Key Concepts and Terminology
- 99. FlattenObjects API Documentation
- 99.1. Container Creation and Configuration
- 99.2. Object Management Operations
- 99.3. Query and Inspection Methods
- 100. Implementation Details
- 100.1. Internal Data Structures
- 100.2. Memory Management and Safety
- 100.3. ID Management System
- 101. Usage Guide and Examples
- 101.1. Basic Operations
- 101.2. Advanced Patterns and Best Practices
- 102. Development and Maintenance
- 102.1. Building and Testing
- 102.2. Project Configuration
- arm_gicv2
- 103. Overview
- 104. Interrupt System Architecture
- 104.1. Interrupt Types and Ranges
- 104.2. Trigger Modes and Translation
- 105. Hardware Interface Implementation
- 105.1. GIC Distributor
- 105.2. GIC CPU Interface
- 106. Development Guide
- 106.1. Build System and Dependencies
- 106.2. CI/CD Pipeline
- 106.3. Development Environment
- axconfig-gen
- 107. Overview
- 107.1. System Architecture
- 107.2. Quick Start Guide
- 108. axconfig-gen Package
- 108.1. Command Line Interface
- 108.2. Library API
- 108.2.1. Core Data Structures
- 108.2.2. Type System
- 108.2.3. Output Generation
- 109. axconfig-macros Package
- 109.1. Macro Usage Patterns
- 109.2. Macro Implementation
- 110. Configuration Examples
- 110.1. TOML Configuration Format
- 110.2. Generated Output Examples
- 111. Development Guide
- 111.1. Build System and Dependencies
- 111.2. Testing
- 111.3. Continuous Integration
- page_table_multiarch
- 112. Overview
- 112.1. System Architecture
- 112.2. Supported Platforms
- 113. Workspace Structure
- 113.1. page_table_multiarch Crate
- 113.2. page_table_entry Crate
- 114. Core Concepts
- 114.1. PageTable64 Implementation
- 114.2. Generic Traits System
- 114.3. Memory Mapping Flags
- 115. Architecture Support
- 115.1. x86_64 Support
- 115.2. AArch64 Support
- 115.3. RISC-V Support
- 115.4. LoongArch64 Support
- 116. Development Guide
- 116.1. Building and Testing
- 116.2. Contributing
- x86_rtc
- 117. Overview
- 117.1. Crate Definition and Metadata
- 117.2. Quick Start Guide
- 118. Implementation
- 118.1. RTC Driver API
- 118.2. CMOS Hardware Interface
- 118.3. Data Format Handling
- 119. Dependencies and Platform Support
- 119.1. Dependency Analysis
- 119.2. Platform and Architecture Requirements
- 120. Development Workflow
- 120.1. CI/CD Pipeline
- 120.2. Development Environment Setup
- percpu
- 121. Overview
- 121.1. System Components
- 121.2. Supported Platforms
- 122. Getting Started
- 122.1. Installation and Setup
- 122.2. Basic Usage Examples
- 122.3. Feature Flags Configuration
- 123. Architecture and Design
- 123.1. Memory Layout and Initialization
- 123.2. Cross-Platform Abstraction
- 123.3. Code Generation Pipeline
- 124. API Reference
- 124.1. def_percpu Macro
- 124.2. Runtime Functions
- 124.3. Safety and Preemption
- 125. Implementation Details
- 125.1. Architecture-Specific Code Generation
- 125.2. Naive Implementation
- 125.3. Memory Management Internals
- 126. Development and Testing
- 126.1. Testing Guide
- 126.2. Build System
- 126.3. Contributing
- axdriver_crates
- 127. Overview
- 128. Architecture and Design
- 129. Foundation Layer (axdriver_base)
- 130. Network Drivers
- 130.1. Network Driver Interface
- 130.2. Network Buffer Management
- 130.3. Hardware Implementations
- 131. Block Storage Drivers
- 131.1. Block Driver Interface
- 131.2. Block Device Implementations
- 132. Display Drivers
- 133. VirtIO Integration
- 133.1. VirtIO Core Abstraction
- 133.2. VirtIO Device Implementations
- 134. PCI Bus Operations
- 135. Development and Build Configuration
- axio
- 136. Overview
- 137. Core I/O Traits
- 138. Crate Configuration and Features
- 139. Implementations
- 139.1. Buffered I/O
- 139.2. Basic Type Implementations
- 140. Supporting Systems
- 140.1. Error Handling
- 140.2. Prelude Module
- 141. Development and Maintenance
- 141.1. Build System and CI
- 141.2. Project Configuration
- riscv_goldfish
- 142. Overview
- 142.1. Architecture Overview
- 143. RTC Driver Implementation
- 143.1. API Reference
- 143.2. Hardware Interface
- 143.3. Time Conversion
- 144. Project Configuration
- 144.1. Target Platforms and Cross-Compilation
- 144.2. Licensing and Distribution
- 145. Development Workflow
- 145.1. CI/CD Pipeline
- 145.2. Development Environment Setup