mirror of
				https://github.com/qemu/qemu.git
				synced 2025-10-31 20:44:16 +00:00 
			
		
		
		
	 ec150c7e09
			
		
	
	
		ec150c7e09
		
	
	
	
	
		
			
			Back in 2016, we discussed[1] rules for headers, and these were
generally liked:
1. Have a carefully curated header that's included everywhere first.  We
   got that already thanks to Peter: osdep.h.
2. Headers should normally include everything they need beyond osdep.h.
   If exceptions are needed for some reason, they must be documented in
   the header.  If all that's needed from a header is typedefs, put
   those into qemu/typedefs.h instead of including the header.
3. Cyclic inclusion is forbidden.
This patch gets include/ closer to obeying 2.
It's actually extracted from my "[RFC] Baby steps towards saner
headers" series[2], which demonstrates a possible path towards
checking 2 automatically.  It passes the RFC test there.
[1] Message-ID: <87h9g8j57d.fsf@blackfin.pond.sub.org>
    https://lists.nongnu.org/archive/html/qemu-devel/2016-03/msg03345.html
[2] Message-Id: <20190711122827.18970-1-armbru@redhat.com>
    https://lists.nongnu.org/archive/html/qemu-devel/2019-07/msg02715.html
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Alistair Francis <alistair.francis@wdc.com>
Message-Id: <20190812052359.30071-2-armbru@redhat.com>
Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
		
	
			
		
			
				
	
	
		
			42 lines
		
	
	
		
			1.2 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			42 lines
		
	
	
		
			1.2 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /* A simple I2C slave for returning monitor EDID data via DDC.
 | |
|  *
 | |
|  * Copyright (c) 2011 Linaro Limited
 | |
|  * Written by Peter Maydell
 | |
|  *
 | |
|  *  This program is free software; you can redistribute it and/or modify
 | |
|  *  it under the terms of the GNU General Public License version 2 as
 | |
|  *  published by the Free Software Foundation.
 | |
|  *
 | |
|  *  This program is distributed in the hope that it will be useful,
 | |
|  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 | |
|  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | |
|  *  GNU General Public License for more details.
 | |
|  *
 | |
|  *  You should have received a copy of the GNU General Public License along
 | |
|  *  with this program; if not, see <http://www.gnu.org/licenses/>.
 | |
|  */
 | |
| 
 | |
| #ifndef I2C_DDC_H
 | |
| #define I2C_DDC_H
 | |
| 
 | |
| #include "hw/display/edid.h"
 | |
| #include "hw/i2c/i2c.h"
 | |
| 
 | |
| /* A simple I2C slave which just returns the contents of its EDID blob. */
 | |
| struct I2CDDCState {
 | |
|     /*< private >*/
 | |
|     I2CSlave i2c;
 | |
|     /*< public >*/
 | |
|     bool firstbyte;
 | |
|     uint8_t reg;
 | |
|     qemu_edid_info edid_info;
 | |
|     uint8_t edid_blob[128];
 | |
| };
 | |
| 
 | |
| typedef struct I2CDDCState I2CDDCState;
 | |
| 
 | |
| #define TYPE_I2CDDC "i2c-ddc"
 | |
| #define I2CDDC(obj) OBJECT_CHECK(I2CDDCState, (obj), TYPE_I2CDDC)
 | |
| 
 | |
| #endif /* I2C_DDC_H */
 |