go-embedded/embd
go-embedded/embd
1
0
Fork 0
mirror of https://github.com/kidoman/embd synced 2025-07-03 11:57:38 +02:00
Code Issues Releases Wiki Activity

added documentation

Browse source
This commit is contained in:
Karan Misra 2014-03-23 07:21:22 +05:30
parent 3f88b67361
commit a35692aabb
6 changed files with 57 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
i2c.go
View file

@ -1,5 +1,8 @@
// I2C support.
package embd
// I2CBus interface is used to interact with the I2C bus.
type I2CBus interface {
// ReadByte reads a byte from the given address.
ReadByte(addr byte) (value byte, err error)
@ -23,6 +26,8 @@ type I2CBus interface {
WriteWordToReg(addr, reg byte, value uint16) error
}
// I2CDriver interface interacts with the host descriptors to allow us
// control of I2C communication.
type I2CDriver interface {
Bus(l byte) I2CBus
@ -31,6 +36,7 @@ type I2CDriver interface {
var i2cDriverInstance I2CDriver
// InitI2C initializes the I2C driver.
func InitI2C() error {
desc, err := DescribeHost()
if err != nil {
@ -46,10 +52,12 @@ func InitI2C() error {
return nil
}
// CloseI2C gracefully closes the I2C driver.
func CloseI2C() error {
return i2cDriverInstance.Close()
}
// NewI2CBus returns a I2CBus corresponding to the provided address.
func NewI2CBus(l byte) I2CBus {
return i2cDriverInstance.Bus(l)
}