Skip to content

connorfeeley/virtual-dts-mode

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

README

virtual-dts-mode

This package provides an auto major mode to view device tree binary files by decompiling them into their equivalent device tree source files.

Features

  • Transparantly convert device tree binary (dtb, dtbo) files between their device tree source (dts) representations.
  • Bidirectional conversion on open and save:
    • Supports converting from binary representation to source representation (dtb -> dts)
    • On save, that source representation is automatically converted back to the binary representation (dts -> dtb).
  • Works over TRAMP.
    • Allows editing a device tree directly on a target via SSH, automatically converting the device tree between binary and source representations as needed.

Requirements

  • Emacs 26.1+ (latest tested: 30.0.50).
  • The device tree compiler, dtc.
    • When virtual-dts-mode is used over TRAMP, dtc must be available on the target system.

Install

straight + use-package

(use-package virtual-dts-mode
  :straight (:host github :repo "connorfeeley/virtual-dts-mode"))

Doom Emacs

Add to your packages.el:

(package! virtual-dts-mode
  :recipe (:host github :repo "connorfeeley/virtual-dts-mode"))

Add to your config.el:

(use-package! virtual-dts-mode)

License

MIT License

Copyright (c) 2022 Connor Feeley

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributing / Issues

Contributions and bug reports are welcome! Either the GitHub mirror or the Sourcehut project can be used.

If you find this package useful, I’d love to hear it - feel free to open an issue or drop me a line at git@cfeeley.org.

Homepage

Note: this repository is automatically mirrored to GitHub, though the canonical location is at Sourcehut.