Skip to content

Commit

Permalink
starting to add doc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
leogdion committed Jan 18, 2024
1 parent a26d55e commit 43325ca
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions Sources/IPSWDownloads/Board.swift
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,12 @@ import Foundation
public struct Board {
public let boardconfig: String
public let platform: String


/// The CHIP tag is a 16-bit unsigned integer that denotes the type of chip the firmware is to be installed to. It is one of the few tags that is not read from the fuses, but is instead hardcoded in the bootchain. It is used to prevent incompatible firmwares from being installed; different processors may have their MMIO registers in different locations.
public let cpid: Int

/// The Board ID of a device (also known as BORD, BDID, or ApBoardId) is a value (usually represented as `uint8\_t`) that represents multiple characteristics of the logic board
public let bdid: Int

public init(boardconfig: String, platform: String, cpid: Int, bdid: Int) {
Expand Down

0 comments on commit 43325ca

Please sign in to comment.