ac97.h

Go to the documentation of this file.

#ifndef __AC97_H
#define __AC97_H

#include <UEFIStarter/pci.h>
#include <UEFIStarter/core/cmdline.h>


#define AC97_BUFFER_COUNT 32 
#define ARG_MUTE   ac97_argument_list[0].value.uint64      
#define ARG_VOLUME ac97_argument_list[1].value.dbl         
#define ARG_SAMPLE_RATE ac97_argument_list[2].value.uint64 
extern cmdline_argument_t ac97_argument_list[];
extern cmdline_argument_group_t ac97_arguments;


#define AC97_MIXER_RESET       0x00 
#define AC97_MIXER_MASTER      0x02 
#define AC97_MIXER_PCM_OUT     0x18 
#define AC97_PCM_RATE_FRONT    0x2C 
#define AC97_PCM_RATE_SURROUND 0x2E 
#define AC97_PCM_RATE_LFE      0x30 
//XXX when adding bus master registers, remember to add non-byte widths to getter function
#define AC97_DESCRIPTOR_PCM_OUT 0x10 
#define AC97_CIV_PCM_OUT        0x14 
#define AC97_LVI_PCM_OUT        0x15 
#define AC97_STATUS_PCM_OUT     0x16 
#define AC97_CONTROL_PCM_OUT    0x1B 
#define AC97_GLOBAL_CONTROL     0x2C 
typedef struct
{
  UINT16 reset;              
  UINT16 master_vol;         
  UINT16 aux_out_vol;        
  UINT16 mono_vol;           
  UINT16 master_tone;        
  UINT16 pc_beep_vol;        
  UINT16 phone_vol;          
  UINT16 mic_vol;            
  UINT16 line_in_vol;        
  UINT16 cd_vol;             
  UINT16 video_vol;          
  UINT16 aux_in_vol;         
  UINT16 pcm_out_vol;        
  UINT16 record_select;      
  UINT16 record_gain;        
  UINT16 record_gain_mic;    
  UINT16 general_purpose;    
  UINT16 three_d_control;    
  UINT16 _reserved24;        
  UINT16 powerdown_ctrlstat; 
  union
  {
    UINT16 raw; 
    struct
    {
      UINT16 vra:1;       
      UINT16 dra:1;       
      UINT16 spdif:1;     
      UINT16 vrm:1;       
      UINT16 dsa:2;       
      UINT16 cdac:1;      
      UINT16 sdac:1;      
      UINT16 ldac:1;      
      UINT16 amap:1;      
      UINT16 rev:2;       
      UINT16 _reserved:2; 
      UINT16 id:2;        
    }; 
  } extended_audio_id;       
  union
  {
    UINT16 raw; 
    struct
    {
      UINT16 vra:1;   
      UINT16 dra:1;   
      UINT16 spdif:1; 
      UINT16 vrm:1;   
      UINT16 spsa:2;  
      UINT16 cdac:1;  
      UINT16 sdac:1;  
      UINT16 ldac:1;  
      UINT16 madc:1;  
      UINT16 spcv:1;  
      UINT16 pri:1;   
      UINT16 prj:1;   
      UINT16 prk:1;   
      UINT16 prl:1;   
      UINT16 vcfg:1;  
    };  
  } extended_audio_statctrl; 
  UINT16 pcm_front_dac_rate; 
  UINT16 pcm_surr_dac_rate;  
  UINT16 pcm_lfe_dac_rate;   
  UINT16 pcm_lr_adc_rate;    
  UINT16 pcm_mic_adc_rate;   
  UINT16 _unhandled3[5];     
  UINT16 _unhandled4[8];     
  UINT16 _unhandled5[8];     
  UINT16 _unhandled6[8];     
  UINT16 _unhandled7[6];     
  UINT16 vendor_id1;         
  UINT16 vendor_id2;         
} ac97_bar_t;

typedef struct
{
  UINT32 address; 
  UINT16 length;  
  union
  {
    UINT16 raw; 
    struct
    {
      UINT16 _reserved:14; 
      UINT16 bup:1; 
      UINT16 ioc:1; 
    }; 
  } control; 
} ac97_buffer_descriptor_t;

typedef struct
{
  ac97_buffer_descriptor_t descriptors[32]; 
  INT16 *buffers[32];                       
} ac97_buffers_s16_t;

typedef struct
{
  ac97_buffers_s16_t *buffers;         
  UINTN buffer_pages;                  
  EFI_PHYSICAL_ADDRESS device_address; 
  void *mapping;                       
  EFI_PCI_IO_PROTOCOL *pci;            
  UINT8 max_master_vol;                
} ac97_handle_t;

typedef union
{
  UINT16 raw; 
  struct
  {
    UINT16 dma_controller_halted:1;                  
    UINT16 current_equals_last_valid:1;              
    UINT16 last_valid_buffer_completion_interrupt:1; 
    UINT16 buffer_completion_interrupt:1;            
    UINT16 fifo_error:1;                             
    UINT16 _reserved:11;                             
  }; 
} ac97_busmaster_status_t;


EFI_PCI_IO_PROTOCOL *find_ac97_device();
void *init_ac97_handle(ac97_handle_t *handle, EFI_PCI_IO_PROTOCOL *pip);
void close_ac97_handle(ac97_handle_t *handle);


#define ac97_mixer_value(LEFT,RIGHT,MUTE) ((((LEFT)&0x3F)<<8)|((RIGHT)&0x3F)|((MUTE)?0x8000:0))

EFI_STATUS write_mixer_reg(ac97_handle_t *handle, UINT32 reg, UINT16 value);
EFI_STATUS read_mixer_reg(ac97_handle_t *handle, UINT32 reg, UINT16 *value);
void print_volume_register(UINT16 *text, UINT16 value);
void print_volume_register_mono(UINT16 *text, UINT16 value);
EFI_STATUS set_ac97_cmdline_volume(ac97_handle_t *handle);
EFI_STATUS set_ac97_cmdline_sample_rate(ac97_handle_t *handle);

EFI_STATUS write_busmaster_reg(ac97_handle_t *handle, UINT32 reg, UINTN value);
EFI_STATUS read_busmaster_reg(ac97_handle_t *handle, UINT32 reg, UINTN *value);

EFI_STATUS flush_ac97_output(ac97_handle_t *handle);
EFI_STATUS ac97_play(ac97_handle_t *handle);
void ac97_wait_until_last_buffer_sent(ac97_handle_t *handle, UINTN timeout_in_milliseconds);


#define AC97_DUMP_VOLUME  0x00000001 
#define AC97_DUMP_OTHER   0x80000000 
#define AC97_DUMP_ALL     -1         
void dump_audio_registers(ac97_handle_t *handle, UINTN flags);


#endif