xref: /openbmc/qemu/include/hw/i2c/smbus_master.h (revision 24496b8d)
1 /*
2  * QEMU SMBus host (master) API
3  *
4  * Copyright (c) 2007 Arastra, Inc.
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 
25 #ifndef HW_SMBUS_MASTER_H
26 #define HW_SMBUS_MASTER_H
27 
28 #include "hw/i2c/i2c.h"
29 
30 /* Master device commands.  */
31 int smbus_quick_command(I2CBus *bus, uint8_t addr, int read);
32 int smbus_receive_byte(I2CBus *bus, uint8_t addr);
33 int smbus_send_byte(I2CBus *bus, uint8_t addr, uint8_t data);
34 int smbus_read_byte(I2CBus *bus, uint8_t addr, uint8_t command);
35 int smbus_write_byte(I2CBus *bus, uint8_t addr, uint8_t command, uint8_t data);
36 int smbus_read_word(I2CBus *bus, uint8_t addr, uint8_t command);
37 int smbus_write_word(I2CBus *bus, uint8_t addr, uint8_t command, uint16_t data);
38 
39 /*
40  * Do a block transfer from an I2C device.  If recv_len is set, then the
41  * first received byte is a length field and is used to know how much data
42  * to receive.  Otherwise receive "len" bytes.  If send_cmd is set, send
43  * the command byte first before receiving the data.
44  */
45 int smbus_read_block(I2CBus *bus, uint8_t addr, uint8_t command, uint8_t *data,
46                      int len, bool recv_len, bool send_cmd);
47 
48 /*
49  * Do a block transfer to an I2C device.  If send_len is set, send the
50  * "len" value before the data.
51  */
52 int smbus_write_block(I2CBus *bus, uint8_t addr, uint8_t command, uint8_t *data,
53                       int len, bool send_len);
54 
55 #endif
56