Skip to content

Safe-I2C #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Uthedris merged 2 commits into from
Nov 22, 2021
Merged

Safe-I2C #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
008db0d
Update I2C.swift
Nov 22, 2021
173c14e
Fix minor bug in setPEC
Nov 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
135 changes: 93 additions & 42 deletions Sources/I2C.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,18 +70,23 @@ extension SwiftyGPIO {

public protocol I2CInterface {
func isReachable(_ address: Int) -> Bool
func setPEC(_ address: Int, enabled: Bool)
@discardableResult func setPEC(_ address: Int, enabled: Bool) -> Bool
func readByte(_ address: Int) -> UInt8
func readByte(_ address: Int, command: UInt8) -> UInt8
func readWord(_ address: Int, command: UInt8) -> UInt16
func readData(_ address: Int, command: UInt8) -> [UInt8]
func readI2CData(_ address: Int, command: UInt8) -> [UInt8]
func writeQuick(_ address: Int)
func writeByte(_ address: Int, value: UInt8)
func writeByte(_ address: Int, command: UInt8, value: UInt8)
func writeWord(_ address: Int, command: UInt8, value: UInt16)
func writeData(_ address: Int, command: UInt8, values: [UInt8])
func writeI2CData(_ address: Int, command: UInt8, values: [UInt8])
func tryReadByte(_ address: Int) -> UInt8?
func tryReadByte(_ address: Int, command: UInt8) -> UInt8?
func tryReadWord(_ address: Int, command: UInt8) -> UInt16?
func tryReadData(_ address: Int, command: UInt8) -> [UInt8]?
func tryReadI2CData(_ address: Int, command: UInt8) -> [UInt8]?
@discardableResult func writeQuick(_ address: Int) -> Bool
@discardableResult func writeByte(_ address: Int, value: UInt8) -> Bool
@discardableResult func writeByte(_ address: Int, command: UInt8, value: UInt8) -> Bool
@discardableResult func writeWord(_ address: Int, command: UInt8, value: UInt16) -> Bool
@discardableResult func writeData(_ address: Int, command: UInt8, values: [UInt8]) -> Bool
@discardableResult func writeI2CData(_ address: Int, command: UInt8, values: [UInt8]) -> Bool
// One-shot rd/wr not provided
}

Expand Down Expand Up @@ -118,6 +123,20 @@ public final class SysFSI2C: I2CInterface {
#endif
}

public func tryReadByte(_ address: Int) -> UInt8? {
setSlaveAddress(address)

let r = i2c_smbus_read_byte()

if r < 0 { return nil }

#if swift(>=4.0)
return UInt8(truncatingIfNeeded: r)
#else
return UInt8(truncatingBitPattern: r)
#endif
}

public func readByte(_ address: Int, command: UInt8) -> UInt8 {
setSlaveAddress(address)

Expand All @@ -134,6 +153,20 @@ public final class SysFSI2C: I2CInterface {
#endif
}

public func tryReadByte(_ address: Int, command: UInt8) -> UInt8? {
setSlaveAddress(address)

let r = i2c_smbus_read_byte_data(command: command)

if r < 0 { return nil; }

#if swift(>=4.0)
return UInt8(truncatingIfNeeded: r)
#else
return UInt8(truncatingBitPattern: r)
#endif
}

public func readWord(_ address: Int, command: UInt8) -> UInt16 {
setSlaveAddress(address)

Expand All @@ -150,6 +183,20 @@ public final class SysFSI2C: I2CInterface {
#endif
}

public func tryReadWord(_ address: Int, command: UInt8) -> UInt16? {
setSlaveAddress(address)

let r = i2c_smbus_read_word_data(command: command)

if r < 0 { return nil }

#if swift(>=4.0)
return UInt16(truncatingIfNeeded: r)
#else
return UInt16(truncatingBitPattern: r)
#endif
}

public func readData(_ address: Int, command: UInt8) -> [UInt8] {
var buf: [UInt8] = [UInt8](repeating:0, count: 32)

Expand All @@ -164,6 +211,19 @@ public final class SysFSI2C: I2CInterface {
return buf
}

public func tryReadData(_ address: Int, command: UInt8) -> [UInt8]? {
var buf: [UInt8] = [UInt8](repeating:0, count: 32)

setSlaveAddress(address)

let r = i2c_smbus_read_block_data(command: command, values: &buf)

if r < 0 { return nil }

return buf
}


public func readI2CData(_ address: Int, command: UInt8) -> [UInt8] {
var buf: [UInt8] = [UInt8](repeating:0, count: 32)

Expand All @@ -178,70 +238,64 @@ public final class SysFSI2C: I2CInterface {
return buf
}

public func writeQuick(_ address: Int) {
public func tryReadI2CData(_ address: Int, command: UInt8) -> [UInt8]? {
var buf: [UInt8] = [UInt8](repeating:0, count: 32)

setSlaveAddress(address)

let r = i2c_smbus_read_i2c_block_data(command: command, values: &buf)

if r < 0 { return nil }

return buf
}

public func writeQuick(_ address: Int) -> Bool {
setSlaveAddress(address)

let r = i2c_smbus_write_quick(value: I2C_SMBUS_WRITE)

if r < 0 {
perror("I2C write failed")
abort()
}
return r >= 0
}

public func writeByte(_ address: Int, value: UInt8) {
public func writeByte(_ address: Int, value: UInt8) -> Bool {
setSlaveAddress(address)

let r = i2c_smbus_write_byte(value: value)

if r < 0 {
perror("I2C write failed")
abort()
}
return r >= 0
}

public func writeByte(_ address: Int, command: UInt8, value: UInt8) {
public func writeByte(_ address: Int, command: UInt8, value: UInt8) -> Bool {
setSlaveAddress(address)

let r = i2c_smbus_write_byte_data(command: command, value: value)

if r < 0 {
perror("I2C write failed")
abort()
}
return r >= 0
}

public func writeWord(_ address: Int, command: UInt8, value: UInt16) {
public func writeWord(_ address: Int, command: UInt8, value: UInt16) -> Bool {
setSlaveAddress(address)

let r = i2c_smbus_write_word_data(command: command, value: value)

if r < 0 {
perror("I2C write failed")
abort()
}
return r >= 0
}

public func writeData(_ address: Int, command: UInt8, values: [UInt8]) {
public func writeData(_ address: Int, command: UInt8, values: [UInt8]) -> Bool {
setSlaveAddress(address)

let r = i2c_smbus_write_block_data(command: command, values: values)

if r < 0 {
perror("I2C write failed")
abort()
}
return r >= 0
}

public func writeI2CData(_ address: Int, command: UInt8, values: [UInt8]) {
public func writeI2CData(_ address: Int, command: UInt8, values: [UInt8]) -> Bool {
setSlaveAddress(address)

let r = i2c_smbus_write_i2c_block_data(command: command, values: values)

if r < 0 {
perror("I2C write failed")
abort()
}
return r >= 0
}

public func isReachable(_ address: Int) -> Bool {
Expand Down Expand Up @@ -270,15 +324,12 @@ public final class SysFSI2C: I2CInterface {
return true
}

public func setPEC(_ address: Int, enabled: Bool) {
public func setPEC(_ address: Int, enabled: Bool) -> Bool {
setSlaveAddress(address)

let r = ioctl(fd, I2C_PEC, enabled ? 1 : 0)

if r != 0 {
perror("I2C communication failed")
abort()
}
return r == 0
}

private func setSlaveAddress(_ to: Int) {
Expand Down