将谓词与 HD 音频编解码器通信

为音频适配器定义声音拓扑时，Hdau.exe 引脚配置工具使用 IOCTL_AZALIABUS_SENDVERBS IOCTL。 请勿将此 IOCTL 用于其他目的。 提供这些有关 IOCTL_AZALIABUS_SENDVERBS 的信息以仅记录其设计和实现。 Windows 7 Hdaudio.sys 音频类驱动程序支持此 IOCTL。

高清 (HD) 音频编解码器能够接收和响应谓词。 这些谓词和对这些谓词的编解码器的响应记录为 HD Audio 规范的一部分。

在 Windows 7 及更高版本的 Windows 操作系统中，HD Audio 类驱动程序使用 IOCTL_AZALIABUS_SENDVERBS IOCTL 与音频编解码器进行谓词通信。 IOCTL_AZALIABUS_SENDVERBS 的定义如下例所示：

#define IOCTL_AZALIABUS_SENDVERBS CTL_CODE(FILE_DEVICE_UNKNOWN, 1, METHOD_BUFFERED, FILE_ANY_ACCESS)

有关 FILE_DEVICE_UNKNOWN、METHOD_BUFFERED 和 FILE_ANY_ACCESS 的详细信息，请参阅 Windows SDK 中的 Devioctl.h 头文件。

为了启动与音频编解码器的通信，类驱动程序会使用以下参数调用 DeviceIoControl 函数。

BOOL DeviceIoControl(
  (HANDLE) hDevice,                      // handle to device
  IOCTL_AZALIABUS_SENDVERBS,             // dwIoControlCode
  NULL,                                  // lpInBuffer
  0,                                     // nInBufferSize
  (LPVOID) lpOutBuffer,                  // output buffer
  (DWORD) nOutBufferSize,                // size of output buffer
  (LPDWORD) lpBytesReturned,             // number of bytes returned
  (LPOVERLAPPED) lpOverlapped            // OVERLAPPED structure
);

如果对 DeviceIoControl 的调用成功，它将返回非零值。 如果调用失败或挂起（未立即处理），DeviceIoControl 将返回零值。 类驱动程序可以调用 GetLastError 以获取更详细的错误消息。

当音频驱动程序必须更改引脚配置默认值时，它可以使用 IOCTL_AZALIABUS_SENDVERBS 从音频编解码器发送和接收 Set 和 Get 谓词。 如果与音频编解码器的通信并非关于引脚配置，则音频编解码器仅会响应 Get 谓词。

以下示例演示了一个函数，该函数采用 AzCorbeEntry 结构和 HANDLE 作为参数，并从编解码器返回 AzRirbResponse。

AzRirbEntry SendVerb(HANDLE handle, AzCorbEntry verb)
{
  UserModeCodecCommandPacket c;
  UserModeCodecResponsePacket r;
  c.NumCommands = 1;
  c.Command[0] = verb;
  DWORD BytesReturned;

//A nonzero value is returned for a successful call and it is interpreted as TRUE  
BOOL rc = DeviceIoControl(handle, IOCTL_AZALIABUS_SENDVERBS, &c, sizeof(c), &r, sizeof(r), &BytesReturned, 0);

  if(!rc)
  {
    printf("Failed to communicate with the device!\n");
    return 0;
  }

  if(BytesReturned != sizeof(r))
  {
    printf("Wrong number of bytes returned!\n");
    return 0;
  }

  return r.Response[0];
}

在前面的代码示例中使用的数据类型和结构在以下示例中定义：

AzCorbEntry

struct AzCorbEntry
{
  ULONG Verb        : 20; // 0:19
  ULONG NodeId      : 7;  // 20:26
  ULONG IndirectNID : 1;  // 27
  ULONG LinkId      : 4;  // 28:31
  enum {Invalid = 0xffffffff};
  AzCorbEntry(ULONG x = 0)
  :
    Verb(x),
    NodeId(x >> 20),
    IndirectNID(x >> 27),
    LinkId(x >> 28) {}
  operator ULONG()
  {
    return Verb | NodeId << 20 | IndirectNID << 27 | LinkId << 28;
  }
};

AzRirbEntry

struct AzRirbEntry
{
  union
  {
    struct 
    {
      ULONG Response  : 21; // 0 : 20
      ULONG SubTag    : 5; // 21 : 25
      ULONG Tag       : 6; // 26 : 31
    } UnsolicitedForm;

    ULONG Response    : 32; // 0:31
  };
  ULONG Sdi         : 4;  // 32:35
  ULONG Unsolicited : 1;  // 36
  ULONG Reserved0   : 26; // 37:62
  ULONG Valid       : 1;  // 63 note this bit only exists
                          // on the "link". The fact that the response
                          // got into memory assures that it is valid
  AzRirbEntry (ULONGLONG x = 0)
  {
    Response = x & 0xffffffff;
    Sdi = x >> 32;
    Unsolicited = x >> 36;
    Reserved0 = x >> 37;
    Valid = x >> 63;
  }
  operator ULONGLONG()
  {
    return (ULONGLONG)Response | (ULONGLONG)Sdi << 32 | (ULONGLONG)Unsolicited << 36 | (ULONGLONG)Reserved0 << 37 | (ULONGLONG)Valid << 63;
  }
};

以下两个结构与谓词传输 IOCTL 一起使用，以启用音频驱动程序和 HD Audio 编解码器之间的命令和响应传输。

UserModeCodecCommandPacket

typedef struct _UserModeCodecCommandPacket
{
  ULONG NumCommands;      // number of commands in this packet
  AzCorbEntry Command[1]; // variable length array of verbs
} UserModeCodecCommandPacket;

UserModeCodecResponsePacket

typedef struct _UserModeCodecResponsePacket
{
  ULONG NumResponses;       // on successful IOCTL, this will be updated with the number of responses.
  AzRirbEntry Response[1];  // Variable length array of responses. lpOutBuffer param to DeviceIoControl
                            // must point to sufficient space to hold this IOCTL with all its responses 
} UserModeCodecResponsePacket;