include/hw/i2c/smbus.h

   1 #ifndef QEMU_SMBUS_H
   2 #define QEMU_SMBUS_H
   3
   4 /*
   5  * QEMU SMBus API
   6  *
   7  * Copyright (c) 2007 Arastra, Inc.
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  22  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25  * THE SOFTWARE.
  26  */
  27
  28 #include "hw/i2c/i2c.h"
  29
  30 #define TYPE_SMBUS_DEVICE "smbus-device"
  31 #define SMBUS_DEVICE(obj) \
  32      OBJECT_CHECK(SMBusDevice, (obj), TYPE_SMBUS_DEVICE)
  33 #define SMBUS_DEVICE_CLASS(klass) \
  34      OBJECT_CLASS_CHECK(SMBusDeviceClass, (klass), TYPE_SMBUS_DEVICE)
  35 #define SMBUS_DEVICE_GET_CLASS(obj) \
  36      OBJECT_GET_CLASS(SMBusDeviceClass, (obj), TYPE_SMBUS_DEVICE)
  37
  38 typedef struct SMBusDeviceClass
  39 {
  40     I2CSlaveClass parent_class;
  41     void (*quick_cmd)(SMBusDevice *dev, uint8_t read);
  42     void (*send_byte)(SMBusDevice *dev, uint8_t val);
  43     uint8_t (*receive_byte)(SMBusDevice *dev);
  44     /* We can't distinguish between a word write and a block write with
  45        length 1, so pass the whole data block including the length byte
  46        (if present).  The device is responsible figuring out what type of
  47        command  this is.  */
  48     void (*write_data)(SMBusDevice *dev, uint8_t cmd, uint8_t *buf, int len);
  49     /* Likewise we can't distinguish between different reads, or even know
  50        the length of the read until the read is complete, so read data a
  51        byte at a time.  The device is responsible for adding the length
  52        byte on block reads.  */
  53     uint8_t (*read_data)(SMBusDevice *dev, uint8_t cmd, int n);
  54 } SMBusDeviceClass;
  55
  56 struct SMBusDevice {
  57     /* The SMBus protocol is implemented on top of I2C.  */
  58     I2CSlave i2c;
  59
  60     /* Remaining fields for internal use only.  */
  61     int mode;
  62     int data_len;
  63     uint8_t data_buf[34]; /* command + len + 32 bytes of data.  */
  64     uint8_t command;
  65 };
  66
  67 /* Master device commands.  */
  68 int smbus_quick_command(I2CBus *bus, uint8_t addr, int read);
  69 int smbus_receive_byte(I2CBus *bus, uint8_t addr);
  70 int smbus_send_byte(I2CBus *bus, uint8_t addr, uint8_t data);
  71 int smbus_read_byte(I2CBus *bus, uint8_t addr, uint8_t command);
  72 int smbus_write_byte(I2CBus *bus, uint8_t addr, uint8_t command, uint8_t data);
  73 int smbus_read_word(I2CBus *bus, uint8_t addr, uint8_t command);
  74 int smbus_write_word(I2CBus *bus, uint8_t addr, uint8_t command, uint16_t data);
  75
  76 /*
  77  * Do a block transfer from an I2C device.  If recv_len is set, then the
  78  * first received byte is a length field and is used to know how much data
  79  * to receive.  Otherwise receive "len" bytes.  If send_cmd is set, send
  80  * the command byte first before receiving the data.
  81  */
  82 int smbus_read_block(I2CBus *bus, uint8_t addr, uint8_t command, uint8_t *data,
  83                      int len, bool recv_len, bool send_cmd);
  84
  85 /*
  86  * Do a block transfer to an I2C device.  If send_len is set, send the
  87  * "len" value before the data.
  88  */
  89 int smbus_write_block(I2CBus *bus, uint8_t addr, uint8_t command, uint8_t *data,
  90                       int len, bool send_len);
  91
  92 void smbus_eeprom_init_one(I2CBus *smbus, uint8_t address, uint8_t *eeprom_buf);
  93 void smbus_eeprom_init(I2CBus *smbus, int nb_eeprom,
  94                        const uint8_t *eeprom_spd, int size);
  95
  96 #endif