[mirror_edk2.git] / DuetPkg / IdeControllerDxe / ComponentName.h

/*++\r
\r
Copyright (c) 2006 - 2007 Intel Corporation. All rights reserved\r
All rights reserved. This program and the accompanying materials                          \r
are licensed and made available under the terms and conditions of the BSD License         \r
which accompanies this distribution.  The full text of the license may be found at        \r
http://opensource.org/licenses/bsd-license.php                                            \r
                                                                                          \r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
\r
\r
Module Name:\r
\r
  ComponentName.h\r
\r
Abstract:\r
\r
\r
Revision History\r
--*/\r
\r
#ifndef _IDE_CONTROLLER_COMPONENT_NAME_H\r
#define _IDE_CONTROLLER_COMPONENT_NAME_H\r
\r
#ifndef EFI_SIZE_REDUCTION_APPLIED\r
\r
#include "Tiano.h"\r
#include EFI_PROTOCOL_DEFINITION (ComponentName)\r
#include EFI_PROTOCOL_DEFINITION (ComponentName2)\r
\r
//\r
// Global Variables definitions\r
//\r
#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
extern EFI_COMPONENT_NAME2_PROTOCOL gIdeControllerName;\r
#else\r
extern EFI_COMPONENT_NAME_PROTOCOL  gIdeControllerName;\r
#endif\r
\r
//\r
// Forward reference declaration\r
//\r
EFI_STATUS\r
EFIAPI\r
IdeControllerGetDriverName (\r
#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
  IN  EFI_COMPONENT_NAME2_PROTOCOL *This,\r
#else\r
  IN  EFI_COMPONENT_NAME_PROTOCOL  *This,\r
#endif\r
  IN  CHAR8                        *Language,\r
  OUT CHAR16                       **DriverName\r
  )\r
/*++\r
\r
  Routine Description:\r
    Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
\r
  Arguments:\r
    This       - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
    Language   - A pointer to a three character ISO 639-2 language identifier.\r
                 This is the language of the driver name that that the caller \r
                 is requesting, and it must match one of the languages specified\r
                 in SupportedLanguages.  The number of languages supported by a \r
                 driver is up to the driver writer.\r
    DriverName - A pointer to the Unicode string to return.  This Unicode string\r
                 is the name of the driver specified by This in the language \r
                 specified by Language.\r
\r
  Returns:\r
    EFI_SUCCESS           - The Unicode string for the Driver specified by This\r
                            and the language specified by Language was returned \r
                            in DriverName.\r
    EFI_INVALID_PARAMETER - Language is NULL.\r
    EFI_INVALID_PARAMETER - DriverName is NULL.\r
    EFI_UNSUPPORTED       - The driver specified by This does not support the \r
                            language specified by Language.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
IdeControllerGetControllerName (\r
#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
  IN  EFI_COMPONENT_NAME2_PROTOCOL                    *This,\r
#else\r
  IN  EFI_COMPONENT_NAME_PROTOCOL                     *This,\r
#endif\r
  IN  EFI_HANDLE                                      ControllerHandle,\r
  IN  EFI_HANDLE                                      ChildHandle        OPTIONAL,\r
  IN  CHAR8                                           *Language,\r
  OUT CHAR16                                          **ControllerName\r
  )\r
/*++\r
\r
  Routine Description:\r
    Retrieves a Unicode string that is the user readable name of the controller\r
    that is being managed by an EFI Driver.\r
\r
  Arguments:\r
    This             - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
    ControllerHandle - The handle of a controller that the driver specified by \r
                       This is managing.  This handle specifies the controller \r
                       whose name is to be returned.\r
    ChildHandle      - The handle of the child controller to retrieve the name \r
                       of.  This is an optional parameter that may be NULL.  It \r
                       will be NULL for device drivers.  It will also be NULL \r
                       for a bus drivers that wish to retrieve the name of the \r
                       bus controller.  It will not be NULL for a bus driver \r
                       that wishes to retrieve the name of a child controller.\r
    Language         - A pointer to a three character ISO 639-2 language \r
                       identifier.  This is the language of the controller name \r
                       that that the caller is requesting, and it must match one\r
                       of the languages specified in SupportedLanguages.  The \r
                       number of languages supported by a driver is up to the \r
                       driver writer.\r
    ControllerName   - A pointer to the Unicode string to return.  This Unicode\r
                       string is the name of the controller specified by \r
                       ControllerHandle and ChildHandle in the language \r
                       specified by Language from the point of view of the \r
                       driver specified by This. \r
\r
  Returns:\r
    EFI_SUCCESS           - The Unicode string for the user readable name in the \r
                            language specified by Language for the driver \r
                            specified by This was returned in DriverName.\r
    EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
    EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid \r
                            EFI_HANDLE.\r
    EFI_INVALID_PARAMETER - Language is NULL.\r
    EFI_INVALID_PARAMETER - ControllerName is NULL.\r
    EFI_UNSUPPORTED       - The driver specified by This is not currently \r
                            managing the controller specified by \r
                            ControllerHandle and ChildHandle.\r
    EFI_UNSUPPORTED       - The driver specified by This does not support the \r
                            language specified by Language.\r
\r
--*/\r
;\r
\r
#endif\r
\r
#endif\r
Commit	Line	Data
93d4ce91	1	/*++\r
	2	\r
	3	Copyright (c) 2006 - 2007 Intel Corporation. All rights reserved\r
	4	All rights reserved. This program and the accompanying materials \r
	5	are licensed and made available under the terms and conditions of the BSD License \r
	6	which accompanies this distribution. The full text of the license may be found at \r
	7	http://opensource.org/licenses/bsd-license.php \r
	8	\r
	9	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
	10	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
	11	\r
	12	\r
	13	Module Name:\r
	14	\r
	15	ComponentName.h\r
	16	\r
	17	Abstract:\r
	18	\r
	19	\r
	20	Revision History\r
	21	--*/\r
	22	\r
	23	#ifndef _IDE_CONTROLLER_COMPONENT_NAME_H\r
	24	#define _IDE_CONTROLLER_COMPONENT_NAME_H\r
	25	\r
	26	#ifndef EFI_SIZE_REDUCTION_APPLIED\r
	27	\r
	28	#include "Tiano.h"\r
	29	#include EFI_PROTOCOL_DEFINITION (ComponentName)\r
	30	#include EFI_PROTOCOL_DEFINITION (ComponentName2)\r
	31	\r
	32	//\r
	33	// Global Variables definitions\r
	34	//\r
	35	#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
	36	extern EFI_COMPONENT_NAME2_PROTOCOL gIdeControllerName;\r
	37	#else\r
	38	extern EFI_COMPONENT_NAME_PROTOCOL gIdeControllerName;\r
	39	#endif\r
	40	\r
	41	//\r
	42	// Forward reference declaration\r
	43	//\r
	44	EFI_STATUS\r
	45	EFIAPI\r
	46	IdeControllerGetDriverName (\r
	47	#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
	48	IN EFI_COMPONENT_NAME2_PROTOCOL *This,\r
	49	#else\r
	50	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
	51	#endif\r
	52	IN CHAR8 *Language,\r
	53	OUT CHAR16 **DriverName\r
	54	)\r
	55	/*++\r
	56	\r
	57	Routine Description:\r
	58	Retrieves a Unicode string that is the user readable name of the EFI Driver.\r
	59	\r
	60	Arguments:\r
	61	This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
	62	Language - A pointer to a three character ISO 639-2 language identifier.\r
	63	This is the language of the driver name that that the caller \r
	64	is requesting, and it must match one of the languages specified\r
65	in SupportedLanguages. The number of languages supported by a \r
66	driver is up to the driver writer.\r
67	DriverName - A pointer to the Unicode string to return. This Unicode string\r
68	is the name of the driver specified by This in the language \r
69	specified by Language.\r
70	\r
71	Returns:\r
72	EFI_SUCCESS - The Unicode string for the Driver specified by This\r
73	and the language specified by Language was returned \r
74	in DriverName.\r
75	EFI_INVALID_PARAMETER - Language is NULL.\r
76	EFI_INVALID_PARAMETER - DriverName is NULL.\r
77	EFI_UNSUPPORTED - The driver specified by This does not support the \r
78	language specified by Language.\r
79	\r
80	--*/\r
81	;\r
82	\r
83	EFI_STATUS\r
84	EFIAPI\r
85	IdeControllerGetControllerName (\r
86	#if (EFI_SPECIFICATION_VERSION >= 0x00020000)\r
87	IN EFI_COMPONENT_NAME2_PROTOCOL *This,\r
88	#else\r
89	IN EFI_COMPONENT_NAME_PROTOCOL *This,\r
90	#endif\r
91	IN EFI_HANDLE ControllerHandle,\r
92	IN EFI_HANDLE ChildHandle OPTIONAL,\r
93	IN CHAR8 *Language,\r
94	OUT CHAR16 **ControllerName\r
95	)\r
96	/*++\r
97	\r
98	Routine Description:\r
99	Retrieves a Unicode string that is the user readable name of the controller\r
100	that is being managed by an EFI Driver.\r
101	\r
102	Arguments:\r
103	This - A pointer to the EFI_COMPONENT_NAME_PROTOCOL instance.\r
104	ControllerHandle - The handle of a controller that the driver specified by \r
105	This is managing. This handle specifies the controller \r
106	whose name is to be returned.\r
107	ChildHandle - The handle of the child controller to retrieve the name \r
108	of. This is an optional parameter that may be NULL. It \r
109	will be NULL for device drivers. It will also be NULL \r
110	for a bus drivers that wish to retrieve the name of the \r
111	bus controller. It will not be NULL for a bus driver \r
112	that wishes to retrieve the name of a child controller.\r
113	Language - A pointer to a three character ISO 639-2 language \r
114	identifier. This is the language of the controller name \r
115	that that the caller is requesting, and it must match one\r
116	of the languages specified in SupportedLanguages. The \r
117	number of languages supported by a driver is up to the \r
118	driver writer.\r
119	ControllerName - A pointer to the Unicode string to return. This Unicode\r
120	string is the name of the controller specified by \r
121	ControllerHandle and ChildHandle in the language \r
122	specified by Language from the point of view of the \r
123	driver specified by This. \r
124	\r
125	Returns:\r
126	EFI_SUCCESS - The Unicode string for the user readable name in the \r
127	language specified by Language for the driver \r
128	specified by This was returned in DriverName.\r
129	EFI_INVALID_PARAMETER - ControllerHandle is not a valid EFI_HANDLE.\r
130	EFI_INVALID_PARAMETER - ChildHandle is not NULL and it is not a valid \r
131	EFI_HANDLE.\r
132	EFI_INVALID_PARAMETER - Language is NULL.\r
133	EFI_INVALID_PARAMETER - ControllerName is NULL.\r
134	EFI_UNSUPPORTED - The driver specified by This is not currently \r
135	managing the controller specified by \r
136	ControllerHandle and ChildHandle.\r
137	EFI_UNSUPPORTED - The driver specified by This does not support the \r
138	language specified by Language.\r
139	\r
140	--*/\r
141	;\r
142	\r
143	#endif\r
144	\r
145	#endif\r