1 #ifndef QEMU_I2C_H 2 #define QEMU_I2C_H 3 4 #include "hw/qdev-core.h" 5 #include "qom/object.h" 6 7 /* The QEMU I2C implementation only supports simple transfers that complete 8 immediately. It does not support slave devices that need to be able to 9 defer their response (eg. CPU slave interfaces where the data is supplied 10 by the device driver in response to an interrupt). */ 11 12 enum i2c_event { 13 I2C_START_RECV, 14 I2C_START_SEND, 15 I2C_FINISH, 16 I2C_NACK /* Masker NACKed a receive byte. */ 17 }; 18 19 20 #define TYPE_I2C_SLAVE "i2c-slave" 21 OBJECT_DECLARE_TYPE(I2CSlave, I2CSlaveClass, 22 I2C_SLAVE) 23 24 struct I2CSlaveClass { 25 DeviceClass parent_class; 26 27 /* Master to slave. Returns non-zero for a NAK, 0 for success. */ 28 int (*send)(I2CSlave *s, uint8_t data); 29 30 /* 31 * Slave to master. This cannot fail, the device should always 32 * return something here. 33 */ 34 uint8_t (*recv)(I2CSlave *s); 35 36 /* 37 * Notify the slave of a bus state change. For start event, 38 * returns non-zero to NAK an operation. For other events the 39 * return code is not used and should be zero. 40 */ 41 int (*event)(I2CSlave *s, enum i2c_event event); 42 }; 43 44 struct I2CSlave { 45 DeviceState qdev; 46 47 /* Remaining fields for internal use by the I2C code. */ 48 uint8_t address; 49 }; 50 51 #define TYPE_I2C_BUS "i2c-bus" 52 OBJECT_DECLARE_SIMPLE_TYPE(I2CBus, I2C_BUS) 53 54 typedef struct I2CNode I2CNode; 55 56 struct I2CNode { 57 I2CSlave *elt; 58 QLIST_ENTRY(I2CNode) next; 59 }; 60 61 typedef QLIST_HEAD(I2CNodeList, I2CNode) I2CNodeList; 62 63 struct I2CBus { 64 BusState qbus; 65 I2CNodeList current_devs; 66 uint8_t saved_address; 67 bool broadcast; 68 }; 69 70 I2CBus *i2c_init_bus(DeviceState *parent, const char *name); 71 void i2c_set_slave_address(I2CSlave *dev, uint8_t address); 72 int i2c_bus_busy(I2CBus *bus); 73 int i2c_start_transfer(I2CBus *bus, uint8_t address, int recv); 74 void i2c_end_transfer(I2CBus *bus); 75 void i2c_nack(I2CBus *bus); 76 int i2c_send_recv(I2CBus *bus, uint8_t *data, bool send); 77 int i2c_send(I2CBus *bus, uint8_t data); 78 uint8_t i2c_recv(I2CBus *bus); 79 80 /** 81 * Create an I2C slave device on the heap. 82 * @name: a device type name 83 * @addr: I2C address of the slave when put on a bus 84 * 85 * This only initializes the device state structure and allows 86 * properties to be set. Type @name must exist. The device still 87 * needs to be realized. See qdev-core.h. 88 */ 89 I2CSlave *i2c_slave_new(const char *name, uint8_t addr); 90 91 /** 92 * Create and realize an I2C slave device on the heap. 93 * @bus: I2C bus to put it on 94 * @name: I2C slave device type name 95 * @addr: I2C address of the slave when put on a bus 96 * 97 * Create the device state structure, initialize it, put it on the 98 * specified @bus, and drop the reference to it (the device is realized). 99 */ 100 I2CSlave *i2c_slave_create_simple(I2CBus *bus, const char *name, uint8_t addr); 101 102 /** 103 * Realize and drop a reference an I2C slave device 104 * @dev: I2C slave device to realize 105 * @bus: I2C bus to put it on 106 * @addr: I2C address of the slave on the bus 107 * @errp: pointer to NULL initialized error object 108 * 109 * Returns: %true on success, %false on failure. 110 * 111 * Call 'realize' on @dev, put it on the specified @bus, and drop the 112 * reference to it. 113 * 114 * This function is useful if you have created @dev via qdev_new(), 115 * i2c_slave_new() or i2c_slave_try_new() (which take a reference to 116 * the device it returns to you), so that you can set properties on it 117 * before realizing it. If you don't need to set properties then 118 * i2c_slave_create_simple() is probably better (as it does the create, 119 * init and realize in one step). 120 * 121 * If you are embedding the I2C slave into another QOM device and 122 * initialized it via some variant on object_initialize_child() then 123 * do not use this function, because that family of functions arrange 124 * for the only reference to the child device to be held by the parent 125 * via the child<> property, and so the reference-count-drop done here 126 * would be incorrect. (Instead you would want i2c_slave_realize(), 127 * which doesn't currently exist but would be trivial to create if we 128 * had any code that wanted it.) 129 */ 130 bool i2c_slave_realize_and_unref(I2CSlave *dev, I2CBus *bus, Error **errp); 131 132 /* lm832x.c */ 133 void lm832x_key_event(DeviceState *dev, int key, int state); 134 135 extern const VMStateDescription vmstate_i2c_slave; 136 137 #define VMSTATE_I2C_SLAVE(_field, _state) { \ 138 .name = (stringify(_field)), \ 139 .size = sizeof(I2CSlave), \ 140 .vmsd = &vmstate_i2c_slave, \ 141 .flags = VMS_STRUCT, \ 142 .offset = vmstate_offset_value(_state, _field, I2CSlave), \ 143 } 144 145 #endif 146