bcmpropertytags.h

//
// bcmpropertytags.h
//
// Circle - A C++ bare metal environment for Raspberry Pi
// Copyright (C) 2014-2022  R. Stange <rsta2@o2online.de>
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// 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 _circle_bcmpropertytags_h
#define _circle_bcmpropertytags_h

#include <circle/bcmmailbox.h>
#include <circle/macros.h>
#include <circle/types.h>

#define PROPTAG_END			0x00000000

#define PROPTAG_GET_FIRMWARE_REVISION	0x00000001
#define PROPTAG_SET_CURSOR_INFO		0x00008010
#define PROPTAG_SET_CURSOR_STATE	0x00008011
#define PROPTAG_GET_BOARD_MODEL		0x00010001
#define PROPTAG_GET_BOARD_REVISION	0x00010002
#define PROPTAG_GET_MAC_ADDRESS		0x00010003
#define PROPTAG_GET_BOARD_SERIAL	0x00010004
#define PROPTAG_GET_ARM_MEMORY		0x00010005
#define PROPTAG_GET_VC_MEMORY		0x00010006
#define PROPTAG_SET_POWER_STATE		0x00028001
#define PROPTAG_GET_CLOCK_RATE		0x00030002
#define PROPTAG_GET_MAX_CLOCK_RATE	0x00030004
#define PROPTAG_GET_TEMPERATURE		0x00030006
#define PROPTAG_GET_MIN_CLOCK_RATE	0x00030007
#define PROPTAG_GET_TURBO		0x00030009
#define PROPTAG_GET_MAX_TEMPERATURE	0x0003000A
#define PROPTAG_GET_EDID_BLOCK		0x00030020
#define PROPTAG_GET_THROTTLED		0x00030046
#define PROPTAG_GET_CLOCK_RATE_MEASURED	0x00030047
#define PROPTAG_NOTIFY_XHCI_RESET	0x00030058
#define PROPTAG_SET_CLOCK_RATE		0x00038002
#define PROPTAG_SET_TURBO		0x00038009
#define PROPTAG_SET_DOMAIN_STATE	0x00038030
#define PROPTAG_SET_SET_GPIO_STATE	0x00038041
#define PROPTAG_SET_SDHOST_CLOCK	0x00038042
#define PROPTAG_ALLOCATE_BUFFER		0x00040001
#define PROPTAG_GET_DISPLAY_DIMENSIONS	0x00040003
#define PROPTAG_GET_PITCH		0x00040008
#define PROPTAG_GET_TOUCHBUF		0x0004000F
#define PROPTAG_GET_GPIO_VIRTBUF	0x00040010
#define PROPTAG_GET_NUM_DISPLAYS	0x00040013
#define PROPTAG_SET_PHYS_WIDTH_HEIGHT	0x00048003
#define PROPTAG_SET_VIRT_WIDTH_HEIGHT	0x00048004
#define PROPTAG_SET_DEPTH		0x00048005
#define PROPTAG_SET_VIRTUAL_OFFSET	0x00048009
#define PROPTAG_SET_PALETTE		0x0004800B
#define PROPTAG_WAIT_FOR_VSYNC		0x0004800E
#define PROPTAG_SET_BACKLIGHT		0x0004800F
#define PROPTAG_SET_DISPLAY_NUM		0x00048013
#define PROPTAG_SET_TOUCHBUF		0x0004801F
#define PROPTAG_SET_GPIO_VIRTBUF	0x00048020
#define PROPTAG_GET_COMMAND_LINE	0x00050001
#define PROPTAG_GET_DMA_CHANNELS	0x00060001

struct TPropertyTag
{
	u32	nTagId;
	u32	nValueBufSize;			// bytes, multiple of 4
	u32	nValueLength;			// bytes
	#define VALUE_LENGTH_RESPONSE	(1 << 31)
	//u8	ValueBuffer[0];			// must be padded to be 4 byte aligned
}
PACKED;

struct TPropertyTagSimple
{
	TPropertyTag	Tag;
	u32		nValue;
}
PACKED;

struct TPropertyTagSetCursorInfo
{
	TPropertyTag	Tag;
	union
	{
		u32	nWidth;			// should be >= 16
		u32	nResponse;
	#define CURSOR_RESPONSE_VALID	0	// response
	}
	PACKED;
	u32		nHeight;		// should be >= 16
	u32		nUnused;
	u32		nPixelPointer;		// physical address, format 32bpp ARGB
	u32		nHotspotX;
	u32		nHotspotY;
}
PACKED;

struct TPropertyTagSetCursorState
{
	TPropertyTag	Tag;
	union
	{
		u32	nEnable;
	#define CURSOR_ENABLE_INVISIBLE		0
	#define CURSOR_ENABLE_VISIBLE		1
		u32	nResponse;
	}
	PACKED;
	u32		nPosX;
	u32		nPosY;
	u32		nFlags;
	#define CURSOR_FLAGS_DISP_COORDS	0
	#define CURSOR_FLAGS_FB_COORDS		1
}
PACKED;

struct TPropertyTagMACAddress
{
	TPropertyTag	Tag;
	u8		Address[6];
	u8		Padding[2];
}
PACKED;

struct TPropertyTagSerial
{
	TPropertyTag	Tag;
	u32		Serial[2];
}
PACKED;

struct TPropertyTagMemory
{
	TPropertyTag	Tag;
	u32		nBaseAddress;
	u32		nSize;			// bytes
}
PACKED;

struct TPropertyTagPowerState
{
	TPropertyTag	Tag;
	u32		nDeviceId;
	#define DEVICE_ID_SD_CARD	0
	#define DEVICE_ID_USB_HCD	3
	u32		nState;
	#define POWER_STATE_OFF		(0 << 0)
	#define POWER_STATE_ON		(1 << 0)
	#define POWER_STATE_WAIT	(1 << 1)
	#define POWER_STATE_NO_DEVICE	(1 << 1)	// in response
}
PACKED;

struct TPropertyTagDomainState
{
	TPropertyTag	Tag;
	u32		nDomainId;
	#define DOMAIN_ID_UNICAM0	13
	#define DOMAIN_ID_UNICAM1	14
	u32		nOn;
	#define DOMAIN_STATE_OFF	0
	#define DOMAIN_STATE_ON		1
}
PACKED;

struct TPropertyTagClockRate
{
	TPropertyTag	Tag;
	u32		nClockId;
	#define CLOCK_ID_EMMC		1
	#define CLOCK_ID_UART		2
	#define CLOCK_ID_ARM		3
	#define CLOCK_ID_CORE		4
	#define CLOCK_ID_EMMC2		12
	#define CLOCK_ID_PIXEL_BVB	14
	u32		nRate;			// Hz
}
PACKED;

struct TPropertyTemperature
{
	TPropertyTag	Tag;
	u32		nTemperatureId;
	#define TEMPERATURE_ID		0
	u32		nValue;			// degree Celsius * 1000
}
PACKED;
#define TPropertyTagTemperature		TPropertyTemperature

struct TPropertyTagTurbo
{
	TPropertyTag	Tag;
	u32		nTurboId;
	#define TURBO_ID		0
	u32		nLevel;
	#define TURBO_OFF		0
	#define TURBO_ON		1
}
PACKED;

struct TPropertyTagGPIOState
{
	TPropertyTag	Tag;
	u32		nGPIO;
	#define EXP_GPIO_BASE		128
	#define EXP_GPIO_NUM		8
	u32		nState;
}
PACKED;

struct TPropertyTagEDIDBlock
{
	TPropertyTag	Tag;
	u32		nBlockNumber;
	#define EDID_FIRST_BLOCK	0
	u32		nStatus;
	#define EDID_STATUS_SUCCESS	0
	u8		Block[128];
}
PACKED;

struct TPropertyTagSetClockRate
{
	TPropertyTag	Tag;
	u32		nClockId;
	u32		nRate;			// Hz
	u32		nSkipSettingTurbo;
	#define SKIP_SETTING_TURBO	1	// when setting ARM clock
}
PACKED;

struct TPropertyTagAllocateBuffer
{
	TPropertyTag	Tag;
	union
	{
		u32	nAlignment;		// in bytes
		u32	nBufferBaseAddress;
	}
	PACKED;
	u32		nBufferSize;
}
PACKED;

struct TPropertyTagDisplayDimensions
{
	TPropertyTag	Tag;
	u32		nWidth;
	u32		nHeight;
}
PACKED;

struct TPropertyTagVirtualOffset
{
	TPropertyTag	Tag;
	u32		nOffsetX;
	u32		nOffsetY;
}
PACKED;

struct TPropertyTagSetPalette
{
	TPropertyTag	Tag;
	union
	{
		u32	nOffset;		// first palette index to set (0-255)
		u32	nResult;
	#define SET_PALETTE_VALID	0
	}
	PACKED;
	u32		nLength;		// number of palette entries to set (1-256)
	u32		Palette[0];		// RGBA values, offset to offset+length-1
}
PACKED;

struct TPropertyTagCommandLine
{
	TPropertyTag	Tag;
	u8		String[2048];
}
PACKED;

class CBcmPropertyTags
{
public:
	CBcmPropertyTags (boolean bEarlyUse = FALSE);		// do not use spinlock early
	~CBcmPropertyTags (void);

	boolean GetTag (u32	  nTagId,			// tag identifier
			void	 *pTag,				// pointer to tag struct
			unsigned  nTagSize,			// size of tag struct
			unsigned  nRequestParmSize = 0);	// number of parameter bytes
	
	boolean GetTags (void	 *pTags,			// pointer to tags struct
			 unsigned nTagsSize);			// size of tags struct

private:
	CBcmMailBox m_MailBox;
};

#endif