pirev

README

go-pirev

Raspberry Pi revision code parser in Go

A Go library for parsing and extracting hardware information from a Raspberry Pi revision code as structured data or raw bit values.

Also includes a basic CLI tool that uses this library to display the details of a Raspberry Pi revision code.

Installation

Library

In the directory of your module run:

go get github.com/antichris/go-pirev@latest

CLI tool

go install github.com/antichris/go-pirev/cmd/pirev@latest

License

The source code of this project is released under Mozilla Public License Version 2.0. See LICENSE.

Documentation

Overview

Package pirev parses Raspberry Pi new-style revision codes.

Index

• type Code
• type Info
  • func Identify(r Code) Info
• type Manufacturer
  • func (i Manufacturer) String() string
• type Model
  • func (i Model) String() string
• type Processor
  • func (i Processor) String() string

Types

type Code

type Code uint32

Code is a Raspberry Pi revision code.

type Info

type Info struct {
	Revision        uint8 // 1.#
	Model           Model
	Processor       Processor
	Manufacturer    Manufacturer
	MemSize         uint // In megabytes
	NewStyleRev     bool // New-style revision code
	WarrantyVoid    bool // Warranty has been voided by overclocking
	NoOTPReading    bool // OTP reading disallowed
	NoOTPPrograming bool // OTP programming disallowed
	NoOvervoltage   bool // Overvoltage disallowed
}

Info describes Raspberry Pi hardware as identified by revision code.

func Identify

func Identify(r Code) Info

Identify hardware from a revision code.

type Manufacturer

type Manufacturer uint8

Manufacturer is a 4-bit value.

const (
	SonyUK Manufacturer = iota // Sony UK
	Egoman
	Embest
	SonyJapan // Sony Japan
	// Embest2 is the same as Embest, if the docs can be believed.
	Embest2 // Embest
	Stadium
)

Manufacturer constants.

func (Manufacturer) String

func (i Manufacturer) String() string

type Model

type Model uint8

Model is an 8-bit value.

const (
	A Model = iota
	B
	APlus // A+
	BPlus // B+
	TwoB  // 2B
	Alpha // Alpha (early prototype)
	CM1

	ThreeB // 3B
	Zero
	CM3

	ZeroW       // Zero W
	ThreeBPlus  // 3B+
	ThreeAPlus  // 3A+
	Internal    // Internal use only
	CM3Plus     // CM3+
	FourB       // 4B
	Zero2W      // Zero 2 W
	FourHundred // 400
	CM4
	CM4S
)

Model constants.

func (Model) String

func (i Model) String() string

type Processor

type Processor uint8

Processor is a 4-bit value.

const (
	BCM2835 Processor = iota
	BCM2836
	BCM2837
	BCM2711
)

Processor type constants.

func (Processor) String

func (i Processor) String() string