path: root/lib/cec.h

/*
 * Copyright
 *
 * Copyright (C) 2009-2010 Christian König (deathsimple@vodafone.de)
 *
 * License
 *
 * This program is free software; you can redistribute and/or modify
 * program under the terms of GNU General Public license either version 3
 * of the License, or (at your option) any later version. 
 *
 */

#ifndef _CEC_H_
#define _CEC_H_

#include <stdint.h>
#include <stdio.h>

#pragma pack(push,1)

enum CEC_Opcode
{
	CEC_Feature_Abort			= 0x00,
	CEC_Image_View_On			= 0x04,
	CEC_Tuner_Step_Increment		= 0x05,
	CEC_Tuner_Step_Decrement		= 0x06,
	CEC_Tuner_Device_Status			= 0x07,
	CEC_Give_Tuner_Device_Status		= 0x08,
	CEC_Record_On				= 0x09,
	CEC_Record_Status			= 0x0A,
	CEC_Record_Off				= 0x0B,
	CEC_Text_View_On			= 0x0D,
	CEC_Record_TV_Screen			= 0x0F,
	CEC_Give_Deck_Status			= 0x1A,
	CEC_Deck_Status				= 0x1B,
	CEC_Set_Menu_Language			= 0x32,
	CEC_Clear_Analogue_Timer		= 0x33,
	CEC_Set_Analogue_Timer			= 0x34,
	CEC_Timer_Status			= 0x35,
	CEC_Standby				= 0x36,
	CEC_Play				= 0x41,
	CEC_Deck_Control			= 0x42,
	CEC_Timer_Cleared_Status		= 0x43,
	CEC_User_Control_Pressed		= 0x44,
	CEC_User_Control_Released		= 0x45,
	CEC_Give_OSD_Name			= 0x46,
	CEC_Set_OSD_Name			= 0x47,
	CEC_Set_OSD_String			= 0x64,
	CEC_Set_Timer_Program			= 0x67,
	CEC_System_Audio_Mode_Request		= 0x70,
	CEC_Give_Audio_Status			= 0x71,
	CEC_Set_System_Audio_Mode		= 0x72,
	CEC_Report_Audio_Status			= 0x7A,
	CEC_System_Audio_Mode_Status		= 0x7E,
	CEC_Give_System_Audio_Mode_Status	= 0x7D,
	CEC_Routing_Change			= 0x80,
	CEC_Routing_Information			= 0x81,
	CEC_Active_Source			= 0x82,
	CEC_Give_Physical_Address		= 0x83,
	CEC_Report_Physical_Address		= 0x84,
	CEC_Request_Active_Source		= 0x85,
	CEC_Set_Stream_Path			= 0x86,
	CEC_Device_Vendor_ID			= 0x87,
	CEC_Vendor_Command			= 0x89,
	CEC_Vendor_Remote_Button_Down		= 0x8A,
	CEC_Vendor_Remote_Button_Up		= 0x8B,
	CEC_Give_Device_Vendor_ID		= 0x8C,
	CEC_Menu_Request			= 0x8D,
	CEC_Menu_Status				= 0x8E,
	CEC_Give_Device_Power_Status		= 0x8F,
	CEC_Report_Power_Status			= 0x90,
	CEC_Get_Menu_Language			= 0x91,
	CEC_Select_Analogue_Service		= 0x92,
	CEC_Select_Digital_Service		= 0x93,
	CEC_Set_Digital_Timer			= 0x97,
	CEC_Clear_Digital_Timer			= 0x99,
	CEC_Set_Audio_Rate			= 0x9A,
	CEC_Inactive_Source			= 0x9D,
	CEC_Version				= 0x9E,
	CEC_Get_Version				= 0x9F,
	CEC_Vendor_Command_With_ID		= 0xA0,
	CEC_Clear_External_Timer		= 0xA1,
	CEC_Set_External_Timer			= 0xA2,
	CEC_Abort				= 0xFF
};

enum CEC_Version
{
	CEC_Version_1_1		= 0x00,
	CEC_Version_1_2		= 0x01,
	CEC_Version_1_2a	= 0x02,
	CEC_Version_1_3		= 0x03,
	CEC_Version_1_3a	= 0x04
};

enum CEC_Device_Type
{
	CEC_TV			= 0,
	CEC_Recording_Device	= 1,
	CEC_Tuner		= 3,
	CEC_Playback_Device	= 4,
	CEC_Audio_System	= 5
};

enum CEC_Abort_Reason
{
	CEC_Unrecognized_opcode			= 0,
	CEC_Not_in_correct_mode_to_respond	= 1,
	CEC_Cannot_provide_source		= 2,
	CEC_Invalid_operand			= 3,
	CEC_Refused				= 4
};

enum CEC_Analogue_Broadcast_Type
{
	CEC_Cable	= 0x00,
	CEC_Satellite	= 0x01,
	CEC_Terrestrial	= 0x02
};

enum CEC_Audio_Rate
{
	CEC_Rate_Control_Off		= 0,
	CEC_Wide_Standard_Rate		= 1,
	CEC_Wide_Fast_Rate		= 2,
	CEC_Wide_Slow_Rate		= 3,
	CEC_Narrow_Standard_Rate	= 4,
	CEC_Narrow_Fast_Rate		= 5,
	CEC_Narrow_Slow_Rate		= 6
};

enum CEC_Record_Source_Info
{
	CEC_Recording_currently_selected			= 0x01,
	CEC_Recording_Digital_Service				= 0x02,
	CEC_Recording_Analogue_Service				= 0x03,
	CEC_Recording_External_input				= 0x04,
	CEC_No_recording_unable_to_record_Digital_Service	= 0x05,
	CEC_No_recording_unable_to_record_Analogue_Service	= 0x06,
	CEC_No_recording_unable_to_select_required_service	= 0x07,
	CEC_No_recording_invalid_External_plug_number		= 0x09,
	CEC_No_recording_invalid_External_Physical_Address	= 0x0A,
	CEC_No_recording_CA_system_not_supported		= 0x0B,
	CEC_No_recording_No_or_Insufficient_CA_Entitlements	= 0x0C,
	CEC_No_recording_Not_allowed_to_copy_source		= 0x0D,
	CEC_No_recording_No_further_copies_allowed		= 0x0E,
	CEC_No_recording_no_media				= 0x10,
	CEC_No_recording_playing				= 0x11,
	CEC_No_recording_already_recording			= 0x12,
	CEC_No_recording_media_protected			= 0x13,
	CEC_No_recording_no_source_signal			= 0x14,
	CEC_No_recording_media_problem				= 0x15,
	CEC_No_recording_not_enough_space_available		= 0x16,
	CEC_No_recording_Parental_Lock_On			= 0x17,
	CEC_Recording_terminated_normally			= 0x1A,
	CEC_Recording_has_already_terminated			= 0x1B,
	CEC_No_recording_other_reason				= 0x1F
};

enum CEC_Recording_Sequence
{
	CEC_Sunday	= 0x01,
	CEC_Monday	= 0x02,
	CEC_Tuesday	= 0x04,
	CEC_Wednesday	= 0x08,
	CEC_Thursday	= 0x10,
	CEC_Friday	= 0x20,
	CEC_Saturday	= 0x40,
	CEC_Once_only	= 0x00
};

enum CEC_Broadcast_System
{
	CEC_PAL_BG		= 0,
	CEC_SECAM_L_		= 1,
	CEC_PAL_M		= 2,
	CEC_NTSC_M		= 3,
	CEC_PAL_I		= 4,
	CEC_SECAM_DK		= 5,
	CEC_SECAM_BG		= 6,
	CEC_SECAM_L		= 7,
	CEC_PAL_DK		= 8,
	CEC_Other_System	= 31
};

enum CEC_Deck_Control_Mode
{
	CEC_Cntrl_Wind		= 1,
	CEC_Cntrl_Rewind	= 2,
	CEC_Cntrl_Stop		= 3,
	CEC_Cntrl_Eject		= 4
};

enum CEC_Deck_Info
{
	CEC_Info_Play			= 0x11,
	CEC_Info_Record			= 0x12,
	CEC_Info_Play_Reverse		= 0x13,
	CEC_Info_Still			= 0x14,
	CEC_Info_Slow			= 0x15,
	CEC_Info_Slow_Reverse		= 0x16,
	CEC_Info_Fast_Forward		= 0x17,
	CEC_Info_Fast_Reverse		= 0x18,
	CEC_Info_No_Media		= 0x19,
	CEC_Info_Stop			= 0x1A,
	CEC_Info_Wind			= 0x1B,
	CEC_Info_Rewind			= 0x1C,
	CEC_Info_Index_Search_Forward	= 0x1D,
	CEC_Info_Index_Search_Reverse	= 0x1E,
	CEC_Info_Other_Status		= 0x1F
};

enum CEC_Timer_Cleared_Status_Data
{
	CEC_Timer_not_cleared_recording		= 0x00,
	CEC_Timer_not_cleared_no_matching	= 0x01,
	CEC_Timer_not_cleared_no_info_available	= 0x02,
	CEC_Timer_cleared			= 0x80
};

enum CEC_Status_Request
{
	CEC_Status_Request_On	= 1,
	CEC_Status_Request_Off	= 2,
	CEC_Status_Request_Once	= 3
};

enum CEC_Digital_Broadcast_System
{
	CEC_ARIB_generic	= 0x00,
	CEC_ATSC_generic	= 0x01,
	CEC_DVB_generic		= 0x02,
	CEC_ARIB_BS		= 0x08,
	CEC_ARIB_CS		= 0x09,
	CEC_ARIB_T		= 0x0A,
	CEC_ATSC_Cable		= 0x10,
	CEC_ATSC_Satellite	= 0x11,
	CEC_ATSC_Terrestrial	= 0x12,
	CEC_DVB_C		= 0x18,
	CEC_DVB_S		= 0x19,
	CEC_DVB_S2		= 0x1A,
	CEC_DVB_T		= 0x1B
};

enum CEC_Display_Control
{
	CEC_Display_for_default_time	= 0x00,
	CEC_Display_until_cleared	= 0x40,
	CEC_Clear_previous_message	= 0x80
};

enum CEC_UI_Commands
{
	CEC_UI_Select			= 0x00,
	CEC_UI_Up			= 0x01,
	CEC_UI_Down			= 0x02,
	CEC_UI_Left			= 0x03,
	CEC_UI_Right			= 0x04,
	CEC_UI_Right_Up			= 0x05,
	CEC_UI_Right_Down		= 0x06,
	CEC_UI_Left_Up			= 0x07,
	CEC_UI_Left_Down		= 0x08,
	CEC_UI_Root_Menu		= 0x09,
	CEC_UI_Setup_Menu		= 0x0A,
	CEC_UI_Contents_Menu		= 0x0B,
	CEC_UI_Favorite_Menu		= 0x0C,
	CEC_UI_Exit			= 0x0D,
	CEC_UI_0			= 0x20,
	CEC_UI_1			= 0x21,
	CEC_UI_2			= 0x22,
	CEC_UI_3			= 0x23,
	CEC_UI_4			= 0x24,
	CEC_UI_5			= 0x25,
	CEC_UI_6			= 0x26,
	CEC_UI_7			= 0x27,
	CEC_UI_8			= 0x28,
	CEC_UI_9			= 0x29,
	CEC_UI_Dot			= 0x2A,
	CEC_UI_Enter			= 0x2B,
	CEC_UI_Clear			= 0x2C,
	CEC_UI_Next_Favorite		= 0x2F,
	CEC_UI_Channel_Up		= 0x30,
	CEC_UI_Channel_Down		= 0x31,
	CEC_UI_Previous_Channel		= 0x32,
	CEC_UI_Sound_Select		= 0x33,
	CEC_UI_Input_Select		= 0x34,
	CEC_UI_Display_Information	= 0x35,
	CEC_UI_Help			= 0x36,
	CEC_UI_Page_Up			= 0x37,
	CEC_UI_Page_Down		= 0x38,
	CEC_UI_Power			= 0x40,
	CEC_UI_Volume_Up		= 0x41,
	CEC_UI_Volume_Down		= 0x42,
	CEC_UI_Mute			= 0x43,
	CEC_UI_Play			= 0x44,
	CEC_UI_Stop			= 0x45,
	CEC_UI_Pause			= 0x46,
	CEC_UI_Record			= 0x47,
	CEC_UI_Rewind			= 0x48,
	CEC_UI_Fast_forward		= 0x49,
	CEC_UI_Eject			= 0x4A,
	CEC_UI_Forward			= 0x4B,
	CEC_UI_Backward			= 0x4C,
	CEC_UI_Stop_Record		= 0x4D,
	CEC_UI_Pause_Record		= 0x4E,
	CEC_UI_Angle			= 0x50,
	CEC_UI_Sub_picture		= 0x51,
	CEC_UI_Video_on_Demand		= 0x52,
	CEC_UI_Electronic_Program_Guide	= 0x53,
	CEC_UI_Timer_Programming	= 0x54,
	CEC_UI_Initial_Configuration	= 0x55,
	CEC_UI_Play_Function		= 0x60,
	CEC_UI_Pause_Play_Function	= 0x61,
	CEC_UI_Record_Function		= 0x62,
	CEC_UI_Pause_Record_Function	= 0x63,
	CEC_UI_Stop_Function		= 0x64,
	CEC_UI_Mute_Function		= 0x65,
	CEC_UI_Restore_Volume_Function	= 0x66,
	CEC_UI_Tune_Function		= 0x67,
	CEC_UI_Select_Media_Function	= 0x68,
        CEC_UI_Select_AV_Input_Function	= 0x69,
	CEC_UI_Select_Audio_Input	= 0x6A,
	CEC_UI_Power_Toggle_Function	= 0x6B,
	CEC_UI_Power_Off_Function	= 0x6C,
	CEC_UI_Power_On_Function	= 0x6D,
	CEC_UI_F1			= 0x71,
	CEC_UI_F2			= 0x72,
	CEC_UI_F3			= 0x73,
	CEC_UI_F4			= 0x74,
	CEC_UI_F5			= 0x75,
	CEC_UI_Data			= 0x76,
};

enum CEC_Power_Status
{
	CEC_Power_Status_On		= 0x00,
	CEC_Power_Status_Standby	= 0x01,
	CEC_Transition_Standby_to_On	= 0x02,
	CEC_Transition_On_to_Standby	= 0x03
};

struct CEC_Audio_Status
{
	uint8_t	volume_status:7;
	uint8_t	mute_status:1;
};

struct CEC_Physical_Address
{
	uint8_t b:4;
	uint8_t a:4;
	uint8_t d:4;
	uint8_t c:4;
};

struct CEC_Record_Source
{
};

struct CEC_Time
{
	uint8_t hour;
	uint8_t minute;
};

struct CEC_Digital_SI
{
	uint8_t	digital_broadcast_system:7;
	uint8_t	service_identification_method:1;
	union
	{
		struct
		{
			uint16_t	transport_stream_id;
			uint16_t	service_id;
			uint16_t	original_network_id;
		} arib;
		struct
		{
			uint16_t	transport_stream_id;
			uint16_t	program_number;
		} atsc;
		struct
		{
			uint16_t	transport_stream_id;
			uint16_t	service_id;
			uint16_t	original_network_id;
		} dvb;
		uint16_t		channel_identifier;
	};
};

struct CEC_Analogue_SI
{
	uint8_t			analogue_broadcast_type;
	uint16_t		analogue_frequency;
	uint8_t			broadcast_system;
};

struct CEC_External_SI
{
	uint8_t					external_source_specifier;
	union
	{
		uint8_t				external_plug;
		struct CEC_Physical_Address	external_physical_address;
	};
};

struct CEC_Tuner_Device_Info
{
	uint8_t	tuner_display_info:7;
	uint8_t recording_flag:1;
	union
	{
		struct CEC_Analogue_SI	analogue_service;
		struct CEC_Digital_SI	digital_service;
	};
};

struct CEC_Timer
{
	uint8_t		day_of_month;
	uint8_t		month_of_year;
	struct CEC_Time	start_time;
	struct CEC_Time	duration;
	uint8_t		recording_sequence;
};

struct CEC_Timer_Status_Data
{
	uint8_t		info:4;
	uint8_t		programmed:1;
	uint8_t		media_info:2;
	uint8_t		timer_overlap_warning:1;
	struct CEC_Time	duration;
};

struct CEC_Packet
{
	uint8_t length;
	uint8_t dst:4;
	uint8_t src:4;
	uint8_t opcode;
	union
	{
		uint8_t	raw_data[14];
		uint8_t record_status;
		uint8_t	timer_cleared_status_data;
		uint8_t	version;
		uint8_t	deck_control_mode;
		uint8_t	deck_info;
		uint8_t	status_request;
		uint8_t	play_mode;
		uint8_t	menu_request_type;
		uint8_t menu_status;
		uint8_t	ui_command;
		uint8_t	power_status;
		uint8_t system_audio_mode_status;
		uint8_t audio_rate;

		char	string[14];
		char	language[3];
		
		struct
		{
			uint8_t	vendor_id[3];
			uint8_t	vendor_specific_data[11];
		};

		struct
		{
			uint8_t	display_control;
			char	display_string[13];
		};

		struct
		{
			struct CEC_Timer		timer;
			union
			{
				struct CEC_Digital_SI	digital_timer;
				struct CEC_Analogue_SI	analogue_timer;
				struct CEC_External_SI	external_timer;
			};
		};

		struct
		{
			struct CEC_Physical_Address	physical_address;
			union
			{
				struct CEC_Physical_Address	physical_address_2;
				uint8_t				device_type;
			};
		};

		struct
		{
			uint8_t	feature_opcode;
			uint8_t	abort_reason;
		};

		struct
		{
			uint8_t audio_volume_status:7;
			uint8_t audio_mute_status:1;
		};

		struct CEC_Record_Source	record_source;
		struct CEC_Timer_Status_Data	timer_status_data;
		struct CEC_Digital_SI		digital_service;
		struct CEC_Analogue_SI		analogue_service;
		struct CEC_Tuner_Device_Info	tuner_device_info;
	};
};

struct CEC_Device;

struct CEC_Hardware
{
	struct CEC_Packet*		(*func_receive)(struct CEC_Device* device);
	int				(*func_transmit)(struct CEC_Device* device, struct CEC_Packet* packet);
	struct CEC_Physical_Address	(*func_get_addr)(struct CEC_Device *device);
};

extern struct CEC_Hardware* MSP430_Open_Hardware(const char* device);
extern void MSP430_Close_Hardware(struct CEC_Hardware* hardware);

enum CEC_Debug
{
	CEC_RX_Packet,
	CEC_TX_Sucess,
	CEC_TX_Failure
};

struct CEC_Device
{
	uint8_t				logical_address:4;
	struct CEC_Physical_Address	physical_address;
	struct CEC_Hardware*		hardware;

	void	(*func_debug)(enum CEC_Debug debug, struct CEC_Device* device, struct CEC_Packet* packet);
	void	(*func_handler[0x100])(struct CEC_Device* device, struct CEC_Packet* packet);
};

extern void CEC_Init_Device(struct CEC_Device* device);
extern int CEC_Alloc_Addr(struct CEC_Device* device, enum CEC_Device_Type device_type);
extern void CEC_Unrecognized_Opcode(struct CEC_Device* device, struct CEC_Packet* packet);

extern void CEC_Dump_Packet(FILE* stream, struct CEC_Packet* packet);

extern void CEC_Receive(struct CEC_Device* device);
extern int CEC_Transmit(struct CEC_Device* device, struct CEC_Packet* packet);

extern int CEC_TX_Ping(struct CEC_Device* device, uint8_t addr);
extern int CEC_TX_Feature_Abort(struct CEC_Device* device, uint8_t addr, enum CEC_Opcode opcode, enum CEC_Abort_Reason reason);
extern int CEC_TX_Version(struct CEC_Device* device, uint8_t addr, enum CEC_Version version);
extern int CEC_TX_Report_Power_Status(struct CEC_Device* device, uint8_t addr, enum CEC_Power_Status status);
extern int CEC_TX_Standby(struct CEC_Device* device, uint8_t addr);
extern int CEC_TX_Abort(struct CEC_Device* device, uint8_t addr);
extern int CEC_TX_Give_Audio_Status(struct CEC_Device* device, uint8_t addr);
extern int CEC_TX_User_Control_Pressed(struct CEC_Device* device, uint8_t addr, enum CEC_UI_Commands command);
extern int CEC_TX_User_Control_Released(struct CEC_Device* device, uint8_t addr);
extern int CEC_TX_Give_Physical_Address(struct CEC_Device* device, uint8_t addr);
extern int CEC_TX_Report_Physical_Address(struct CEC_Device* device, enum CEC_Device_Type device_type);
extern int CEC_TX_Active_Source(struct CEC_Device* device);
extern int CEC_TX_Set_System_Audio_Mode(struct CEC_Device* device, int mode);

#pragma pack(pop)

#endif