https://github.com/rust-osdev/x86_64

Library to program x86_64 hardware.
https://github.com/rust-osdev/x86_64

Last synced: about 11 hours ago
JSON representation

Library to program x86_64 hardware.

• Host: GitHub
• URL: https://github.com/rust-osdev/x86_64
• Owner: rust-osdev
• License: apache-2.0
• Created: 2015-11-20T17:15:01.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-08-15T11:36:08.000Z (5 months ago)
• Last Synced: 2024-09-15T13:52:41.837Z (3 months ago)
• Language: Rust
• Homepage: https://docs.rs/x86_64
• Size: 3.62 MB
• Stars: 785
• Watchers: 23
• Forks: 130
• Open Issues: 30
• Metadata Files:
  • Readme: README.md
  • Changelog: Changelog.md
  • License: LICENSE-APACHE
  • Security: SECURITY.md
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
# x86_64 library

[![Crates.io](https://img.shields.io/crates/v/x86_64)](https://crates.io/crates/x86_64)

[![Build Status](https://github.com/rust-osdev/x86_64/workflows/Build/badge.svg)](https://github.com/rust-osdev/x86_64/actions?query=workflow%3ABuild) [![docs.rs](https://img.shields.io/badge/docs.rs-documentation-green.svg)](https://docs.rs/x86_64)

Support for x86_64 specific instructions (e.g. TLB flush), registers (e.g. control registers), and structures (e.g. page tables).

## Crate Feature Flags

* `nightly`: Enables features only available on nightly Rust; enabled by default.

* `instructions`: Enabled by default, turns on x86\_64 specific instructions, and dependent features. Only available for x86\_64 targets.

## Minimum Supported Rust Version (MSRV)

If no nightly features are enabled, Rust 1.59.0 is required.

This can be done by either:

  - `--no-default-features --features instructions`

  - `--no-default-features`

If the `nightly` feature or any of its sub-features is enabled (which is the

default), a recent nightly is required.

## Other OS development crates

This crate does not attempt to handle every facet of OS development. Other

useful crates in this space include:

  - [`raw-cpuid`](https://crates.io/crates/raw-cpuid): safe wrappers around the

  [`cpuid` instruction](https://en.wikipedia.org/wiki/CPUID)

    - Provides parsed versions of the CPUID data, rather than just raw binary values.

    - Support for AMD and Intel specific values.

    - Works on x86 and x86_64 systems, in both user and kernel mode.

  - [`uefi`](https://crates.io/crates/uefi): abstractions for

  [UEFI](https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface)

  (the successor to BIOS)

    - Provides UEFI tables, functions, and types.

    - Useful for writing UEFI applications, or calling UEFI functions from your OS.

    - Works on a variety of modern platforms, not just x86_64.

  - [`volatile`](https://crates.io/crates/volatile): interface to

  [`read_volatile`](https://doc.rust-lang.org/std/ptr/fn.read_volatile.html) and

  [`write_volatile`](https://doc.rust-lang.org/std/ptr/fn.write_volatile.html)

    - Makes it easier to program [MMIO](https://en.wikipedia.org/wiki/Memory-mapped_I/O) interfaces and devices.

    - Works on any Rust target.