hda.c

//BleskOS

/*
* MIT License
* Copyright (c) 2023-2024 Vendelín Slezák
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/

void hda_initalize_sound_card(dword_t sound_card_number) {
 hda_base = sound_cards_info[sound_card_number].mmio_base;
 hda_communication_type = HDA_UNINITALIZED;
 hda_is_initalized_useful_output = STATUS_FALSE;

 //reset card and set operational state
 mmio_outd(hda_base + 0x08, 0x0);
 ticks = 0;
 while(ticks<10) {
  asm("nop");
  if((mmio_ind(hda_base + 0x08) & 0x1)==0x0) {
   break;
  }
 }
 mmio_outd(hda_base + 0x08, 0x1);
 ticks = 0;
 while(ticks<10) {
  asm("nop");
  if((mmio_ind(hda_base + 0x08) & 0x1)==0x1) {
   break;
  }
 }
 if((mmio_ind(hda_base + 0x08) & 0x1)==0x0) {
  log("\n\nHDA ERROR: card can not be set to operational state");
  return;
 }

 //read capabilities
 log("\n\nSound card High Definition Audio ");
 log_var(mmio_inb(hda_base + 0x03));
 log(".");
 log_var(mmio_inb(hda_base + 0x02));
 hda_input_stream_base = (hda_base + 0x80);
 hda_output_stream_base = (hda_base + 0x80 + (0x20*((mmio_inw(hda_base + 0x00)>>8) & 0xF))); //skip input streams ports
 hda_output_buffer_list = (dword_t *) (aligned_calloc(16*2, 0x7F));

 //disable interrupts
 mmio_outd(hda_base + 0x20, 0);
 
 //turn off dma position transfer
 mmio_outd(hda_base + 0x70, 0);
 mmio_outd(hda_base + 0x74, 0);
 
 //disable synchronization
 mmio_outd(hda_base + 0x34, 0);
 mmio_outd(hda_base + 0x38, 0);

 //stop CORB and RIRB
 mmio_outb(hda_base + 0x4C, 0x0);
 mmio_outb(hda_base + 0x5C, 0x0);
 
 //configure CORB
 hda_corb_mem = (dword_t *) (aligned_calloc(256*4, 0x7F));
 mmio_outd(hda_base + 0x40, (dword_t)hda_corb_mem); //CORB lower memory
 mmio_outd(hda_base + 0x44, 0); //CORB upper memory
 if((mmio_inb(hda_base + 0x4E) & 0x40)==0x40) {
  hda_corb_number_of_entries = 256;
  mmio_outb(hda_base + 0x4E, 0x2); //256 entries
  log("\nCORB: 256 entries");
 }
 else if((mmio_inb(hda_base + 0x4E) & 0x20)==0x20) {
  hda_corb_number_of_entries = 16;
  mmio_outb(hda_base + 0x4E, 0x1); //16 entries
  log("\nCORB: 16 entries");
 }
 else if((mmio_inb(hda_base + 0x4E) & 0x10)==0x10) {
  hda_corb_number_of_entries = 2;
  mmio_outb(hda_base + 0x4E, 0x0); //2 entries
  log("\nCORB: 2 entries");
 }
 else { //CORB/RIRB is not supported
  log("\nCORB: no size allowed");
  goto hda_use_pio_interface;
 }
 mmio_outw(hda_base + 0x4A, 0x8000); //reset read pointer
 ticks = 0;
 while(ticks<5) {
  asm("nop");
  if((mmio_inw(hda_base + 0x4A) & 0x8000)==0x8000) { //wait until reset is complete
   break;
  }
 }
 if((mmio_inw(hda_base + 0x4A) & 0x8000)==0x0000) { //CORB read pointer was not reseted
  log("\nHDA: CORB pointer can not be put to reset state");
  goto hda_use_pio_interface;
 }
 mmio_outw(hda_base + 0x4A, 0x0000); //go back to normal state
 ticks = 0;
 while(ticks<5) {
  asm("nop");
  if((mmio_inw(hda_base + 0x4A) & 0x8000)==0x0000) { //wait until is CORB read pointer in normal state
   break;
  }
 }
 if((mmio_inw(hda_base + 0x4A) & 0x8000)==0x8000) { //CORB read pointer is still in reset
  log("\nHDA: CORB pointer can not be put from reset state");
  goto hda_use_pio_interface;
 }
 mmio_outw(hda_base + 0x48, 0); //set write pointer
 hda_corb_pointer = 1;
 
 //configure RIRB
 hda_rirb_mem = (dword_t *) (aligned_calloc(256*8, 0x7F));
 mmio_outd(hda_base + 0x50, (dword_t)hda_rirb_mem); //RIRB lower memory
 mmio_outd(hda_base + 0x54, 0); //RIRB upper memory
 if((mmio_inb(hda_base + 0x5E) & 0x40)==0x40) {
  hda_rirb_number_of_entries = 256;
  mmio_outb(hda_base + 0x5E, 0x2); //256 entries
  log("\nRIRB: 256 entries");
 }
 else if((mmio_inb(hda_base + 0x5E) & 0x20)==0x20) {
  hda_rirb_number_of_entries = 16;
  mmio_outb(hda_base + 0x5E, 0x1); //16 entries
  log("\nRIRB: 16 entries");
 }
 else if((mmio_inb(hda_base + 0x5E) & 0x10)==0x10) {
  hda_rirb_number_of_entries = 2;
  mmio_outb(hda_base + 0x5E, 0x0); //2 entries
  log("\nRIRB: 2 entries");
 }
 else { //CORB/RIRB is not supported
  log("\nRIRB: no size allowed");
  goto hda_use_pio_interface;
 }
 mmio_outw(hda_base + 0x58, 0x8000); //reset write pointer
 wait(10);
 mmio_outw(hda_base + 0x5A, 0); //disable interrupts
 hda_rirb_pointer = 1;
 
 //start CORB and RIRB
 mmio_outb(hda_base + 0x4C, 0x2);
 mmio_outb(hda_base + 0x5C, 0x2);

 //find codec and working communication interface
 //TODO: find more codecs
 for(dword_t codec_number=0, codec_id=0; codec_number<16; codec_number++) {
  hda_communication_type = HDA_CORB_RIRB;
  codec_id = hda_send_verb(codec_number, 0, 0xF00, 0);

  if(codec_id!=0) {
   log("\nHDA: CORB/RIRB communication interface");
   hda_initalize_codec(sound_card_number, codec_number);
   return; //initalization is complete
  }
 }

 hda_use_pio_interface:
 //stop CORB and RIRB
 mmio_outb(hda_base + 0x4C, 0x0);
 mmio_outb(hda_base + 0x5C, 0x0);

 for(dword_t codec_number=0, codec_id=0; codec_number<16; codec_number++) {
  hda_communication_type = HDA_PIO;
  codec_id = hda_send_verb(codec_number, 0, 0xF00, 0);

  if(codec_id!=0) {
   log("\nHDA: PIO communication interface");
   hda_initalize_codec(sound_card_number, codec_number);
   return; //initalization is complete
  }
 }
}

dword_t hda_send_verb(dword_t codec, dword_t node, dword_t verb, dword_t command) {
 dword_t value = ((codec<<28) | (node<<20) | (verb<<8) | (command));
 
 if(hda_communication_type==HDA_CORB_RIRB) { //CORB/RIRB interface
  //write verb
  hda_corb_mem[hda_corb_pointer] = value;
  
  //move write pointer
  mmio_outw(hda_base + 0x48, hda_corb_pointer);
  
  //wait for response
  ticks = 0;
  while(ticks<5) {
   asm("nop");
   if(mmio_inw(hda_base + 0x58)==hda_corb_pointer) {
    break;
   }
  }
  if(mmio_inw(hda_base + 0x58)!=hda_corb_pointer) {
   log("\nHDA ERROR: no response");
   hda_communication_type = HDA_UNINITALIZED;
   return STATUS_ERROR;
  }
  
  //read response
  value = hda_rirb_mem[hda_rirb_pointer*2];

  //move pointers
  hda_corb_pointer++;
  if(hda_corb_pointer==hda_corb_number_of_entries) {
   hda_corb_pointer = 0;
  }
  hda_rirb_pointer++;
  if(hda_rirb_pointer==hda_rirb_number_of_entries) {
   hda_rirb_pointer = 0;
  }

  //return response
  return value;
 }
 else if(hda_communication_type==HDA_PIO) { //PIO interface
  //clear Immediate Result Valid bit
  mmio_outw(hda_base + 0x68, 0x2);

  //write verb
  mmio_outd(hda_base + 0x60, value);

  //start verb transfer
  mmio_outw(hda_base + 0x68, 0x1);

  //pool for response
  ticks = 0;
  while(ticks<3) {
   asm("nop");

   //wait for Immediate Result Valid bit = set and Immediate Command Busy bit = clear
   if((mmio_inw(hda_base + 0x68) & 0x3)==0x2) {
    //clear Immediate Result Valid bit
    mmio_outw(hda_base + 0x68, 0x2);

    //return response
    return mmio_ind(hda_base + 0x64);
   }
  }
  
  //there was no response after 6 ms
  log("\nHDA ERROR: no response");
  hda_communication_type = HDA_UNINITALIZED;
  return STATUS_ERROR;
 }

 return STATUS_ERROR;
}

byte_t hda_get_node_type(dword_t codec, dword_t node) {
 return ((hda_send_verb(codec, node, 0xF00, 0x09) >> 20) & 0xF);
}

word_t hda_get_node_connection_entry(dword_t codec, dword_t node, dword_t connection_entry_number) {
 //read connection capabilities
 dword_t connection_list_capabilities = hda_send_verb(codec, node, 0xF00, 0x0E);

 //test if this connection even exist
 if(connection_entry_number>=(connection_list_capabilities & 0x7F)) {
  return 0x0000;
 }

 //return number of connected node
 if((connection_list_capabilities & 0x80)==0x00) { //short form
  return ((hda_send_verb(codec, node, 0xF02, ((connection_entry_number/4)*4)) >> ((connection_entry_number%4)*8)) & 0xFF);
 }
 else { //long form
  return ((hda_send_verb(codec, node, 0xF02, ((connection_entry_number/2)*2)) >> ((connection_entry_number%2)*16)) & 0xFFFF);
 }
}

void hda_set_node_gain(dword_t codec, dword_t node, dword_t node_type, dword_t capabilities, dword_t gain) {
 //this will apply to left and right
 dword_t payload = 0x3000;

 //set type of node
 if((node_type & HDA_OUTPUT_NODE)==HDA_OUTPUT_NODE) {
  payload |= 0x8000;
 }
 if((node_type & HDA_INPUT_NODE)==HDA_INPUT_NODE) {
  payload |= 0x4000;
 }

 //set number of gain
 if(gain==0 && (capabilities & 0x80000000)==0x80000000) {
  payload |= 0x80; //mute
 }
 else {
  payload |= (((capabilities>>8) & 0x7F)*gain/100); //recalculate range 0-100 to range of node steps
 }

 //change gain
 hda_send_verb(codec, node, 0x300, payload);
}

void hda_enable_pin_output(dword_t codec, dword_t pin_node) {
 hda_send_verb(codec, pin_node, 0x707, (hda_send_verb(codec, pin_node, 0xF07, 0x00) | 0x40));
}

void hda_disable_pin_output(dword_t codec, dword_t pin_node) {
 hda_send_verb(codec, pin_node, 0x707, (hda_send_verb(codec, pin_node, 0xF07, 0x00) & ~0x40));
}

byte_t hda_is_headphone_connected(void) {
 if(hda_pin_headphone_node_number!=0 && (hda_send_verb(hda_codec_number, hda_pin_headphone_node_number, 0xF09, 0x00) & 0x80000000)==0x80000000) {
  return STATUS_TRUE;
 }
 else {
  return STATUS_FALSE;
 }
}

void hda_initalize_codec(dword_t sound_card_number, dword_t codec_number) {
 //test if this codec exist
 dword_t codec_id = hda_send_verb(codec_number, 0, 0xF00, 0);
 if(codec_id==0x00000000) {
  return;
 }
 hda_codec_number = codec_number;

 //log basic codec info
 log("\nCodec ");
 log_var_with_space(codec_number);
 log("\nVendor: ");
 byte_t *vendor_string = (byte_t *) (get_pci_vendor_string(codec_id>>16));
 if(vendor_string[0]==0) {
  log_hex_specific_size((codec_id>>16), 4);
 }
 else {
  log(vendor_string);
 }
 log("\nNumber: ");
 log_hex_specific_size((codec_id & 0xFFFF), 4);

 //find Audio Function Groups
 dword_t subordinate_node_count_reponse = hda_send_verb(codec_number, 0, 0xF00, 0x04);
 log("\nFirst Group node: ");
 log_var_with_space((subordinate_node_count_reponse>>16) & 0xFF);
 log("Number of Groups: ");
 log_var(subordinate_node_count_reponse & 0xFF);
 for(dword_t node = ((subordinate_node_count_reponse>>16) & 0xFF), last_node = (node+(subordinate_node_count_reponse & 0xFF)); node<last_node; node++) {
  if((hda_send_verb(codec_number, node, 0xF00, 0x05) & 0x7F)==0x01) { //this is Audio Function Group
   hda_initalize_audio_function_group(sound_card_number, node); //initalize Audio Function Group
   return;
  }
 }
 log("\nHDA ERROR: No AFG founded");
}

void hda_initalize_audio_function_group(dword_t sound_card_number, dword_t afg_node_number) {
 //reset AFG
 hda_send_verb(hda_codec_number, afg_node_number, 0x7FF, 0x00);

 //enable power for AFG
 hda_send_verb(hda_codec_number, afg_node_number, 0x705, 0x00);

 //disable unsolicited responses
 hda_send_verb(hda_codec_number, afg_node_number, 0x708, 0x00);

 //read available info
 hda_afg_node_sample_capabilities = hda_send_verb(hda_codec_number, afg_node_number, 0xF00, 0x0A);
 hda_afg_node_stream_format_capabilities = hda_send_verb(hda_codec_number, afg_node_number, 0xF00, 0x0B);
 hda_afg_node_input_amp_capabilities = hda_send_verb(hda_codec_number, afg_node_number, 0xF00, 0x0D);
 hda_afg_node_output_amp_capabilities = hda_send_verb(hda_codec_number, afg_node_number, 0xF00, 0x12);

 //log AFG info
 log("\nAudio Function Group node ");
 log_var(afg_node_number);
 log("\nAFG sample capabilities: ");
 log_hex(hda_afg_node_sample_capabilities);
 log("\nAFG stream format capabilities: ");
 log_hex(hda_afg_node_stream_format_capabilities);
 log("\nAFG input amp capabilities: ");
 log_hex(hda_afg_node_input_amp_capabilities);
 log("\nAFG output amp capabilities: ");
 log_hex(hda_afg_node_output_amp_capabilities);

 //log all AFG nodes and find useful PINs
 log(("\n\nLIST OF ALL NODES IN AFG:"));
 dword_t subordinate_node_count_reponse = hda_send_verb(hda_codec_number, afg_node_number, 0xF00, 0x04);
 dword_t pin_alternative_output_node_number = 0, pin_speaker_default_node_number = 0, pin_speaker_node_number = 0, pin_headphone_node_number = 0;
 hda_pin_output_node_number = 0; hda_pin_headphone_node_number = 0;
 for(dword_t node = ((subordinate_node_count_reponse>>16) & 0xFF), last_node = (node+(subordinate_node_count_reponse & 0xFF)), type_of_node = 0; node<last_node; node++) {
  //log number of node
  log("\n");
  log_var_with_space(node);
  
  //get type of node
  type_of_node = hda_get_node_type(hda_codec_number, node);

  //process node
  if(type_of_node==HDA_WIDGET_AUDIO_OUTPUT) {
   log("Audio Output");

   //disable every audio output by connecting it to stream 0
   hda_send_verb(hda_codec_number, node, 0x706, 0x00);
  }
  else if(type_of_node==HDA_WIDGET_AUDIO_INPUT) {
   log("Audio Input");
  }
  else if(type_of_node==HDA_WIDGET_AUDIO_MIXER) {
   log("Audio Mixer");
  }
  else if(type_of_node==HDA_WIDGET_AUDIO_SELECTOR) {
   log("Audio Selector");
  }
  else if(type_of_node==HDA_WIDGET_PIN_COMPLEX) {
   log("Pin Complex ");

   //read type of PIN
   type_of_node = ((hda_send_verb(hda_codec_number, node, 0xF1C, 0x00) >> 20) & 0xF);
   if(type_of_node==HDA_PIN_LINE_OUT) {
    log("Line Out");

    //save this node, this variable contain number of last alternative output
    pin_alternative_output_node_number = node;
   }
   else if(type_of_node==HDA_PIN_SPEAKER) {
    log("Speaker ");

    //first speaker node is default speaker
    if(pin_speaker_default_node_number==0) {
     pin_speaker_default_node_number = node;
    }

    //find if there is device connected to this PIN
    if((hda_send_verb(hda_codec_number, node, 0xF00, 0x09) & 0x4)==0x4) {
     //find if it is jack or fixed device
     if((hda_send_verb(hda_codec_number, node, 0xF1C, 0x00)>>30)!=0x1) {
      //find if is device output capable
      if((hda_send_verb(hda_codec_number, node, 0xF00, 0x0C) & 0x10)==0x10) {
       //there is connected device
       log("connected output device");

       //we will use first pin with connected device, so save node number only for first PIN
       if(pin_speaker_node_number==0) {
        pin_speaker_node_number = node;
       }
      }
      else {
       log("not output capable");
      }
     }
     else {
      log("not jack or fixed device");
     }
    }
    else {
     log("no output device");
    }
   }
   else if(type_of_node==HDA_PIN_HEADPHONE_OUT) {
    log("Headphone Out");

    //save node number
    //TODO: handle if there are multiple HP nodes
    pin_headphone_node_number = node;
   }
   else if(type_of_node==HDA_PIN_CD) {
    log("CD");

    //save this node, this variable contain number of last alternative output
    pin_alternative_output_node_number = node;
   }
   else if(type_of_node==HDA_PIN_SPDIF_OUT) {
    log("SPDIF Out");

    //save this node, this variable contain number of last alternative output
    pin_alternative_output_node_number = node;
   }
   else if(type_of_node==HDA_PIN_DIGITAL_OTHER_OUT) {
    log("Digital Other Out");

    //save this node, this variable contain number of last alternative output
    pin_alternative_output_node_number = node;
   }
   else if(type_of_node==HDA_PIN_MODEM_LINE_SIDE) {
    log("Modem Line Side");

    //save this node, this variable contain number of last alternative output
    pin_alternative_output_node_number = node;
   }
   else if(type_of_node==HDA_PIN_MODEM_HANDSET_SIDE) {
    log("Modem Handset Side");

    //save this node, this variable contain number of last alternative output
    pin_alternative_output_node_number = node;
   }
   else if(type_of_node==HDA_PIN_LINE_IN) {
    log("Line In");
   }
   else if(type_of_node==HDA_PIN_AUX) {
    log("AUX");
   }
   else if(type_of_node==HDA_PIN_MIC_IN) {
    log("Mic In");
   }
   else if(type_of_node==HDA_PIN_TELEPHONY) {
    log("Telephony");
   }
   else if(type_of_node==HDA_PIN_SPDIF_IN) {
    log("SPDIF In");
   }
   else if(type_of_node==HDA_PIN_DIGITAL_OTHER_IN) {
    log("Digital Other In");
   }
   else if(type_of_node==HDA_PIN_RESERVED) {
    log("Reserved");
   }
   else if(type_of_node==HDA_PIN_OTHER) {
    log("Other");
   }
  }
  else if(type_of_node==HDA_WIDGET_POWER_WIDGET) {
   log("Power Widget");
  }
  else if(type_of_node==HDA_WIDGET_VOLUME_KNOB) {
   log("Volume Knob");
  }
  else if(type_of_node==HDA_WIDGET_BEEP_GENERATOR) {
   log("Beep Generator");
  }
  else if(type_of_node==HDA_WIDGET_VENDOR_DEFINED) {
   log("Vendor defined");
  }
  else {
   log("Reserved type");
  }

  //log all connected nodes
  log(" ");
  byte_t connection_entry_number = 0;
  word_t connection_entry_node = hda_get_node_connection_entry(hda_codec_number, node, 0);
  while(connection_entry_node!=0x0000) {
   log_var_with_space(connection_entry_node);
   connection_entry_number++;
   connection_entry_node = hda_get_node_connection_entry(hda_codec_number, node, connection_entry_number);
  }
 }

 //reset variables of second path
 hda_second_audio_output_node_number = 0;
 hda_second_audio_output_node_sample_capabilities = 0;
 hda_second_audio_output_node_stream_format_capabilities = 0;
 hda_second_output_amp_node_number = 0;
 hda_second_output_amp_node_capabilities = 0;

 //initalize output PINs
 log("\n");
 if(pin_speaker_default_node_number!=0) {
  //initalize speaker
  hda_is_initalized_useful_output = STATUS_TRUE;
  if(pin_speaker_node_number!=0) {
   log("\nSpeaker output");
   hda_initalize_output_pin(sound_card_number, pin_speaker_node_number); //initalize speaker with connected output device
   hda_pin_output_node_number = pin_speaker_node_number; //save speaker node number
  }
  else {
   log("\nDefault speaker output");
   hda_initalize_output_pin(sound_card_number, pin_speaker_default_node_number); //initalize default speaker
   hda_pin_output_node_number = pin_speaker_default_node_number; //save speaker node number
  }

  //save speaker path
  hda_second_audio_output_node_number = hda_audio_output_node_number;
  hda_second_audio_output_node_sample_capabilities = hda_audio_output_node_sample_capabilities;
  hda_second_audio_output_node_stream_format_capabilities = hda_audio_output_node_stream_format_capabilities;
  hda_second_output_amp_node_number = hda_output_amp_node_number;
  hda_second_output_amp_node_capabilities = hda_output_amp_node_capabilities;

  //if codec has also headphone output, initalize it
  if(pin_headphone_node_number!=0) {
   log("\n\nHeadphone output");
   hda_initalize_output_pin(sound_card_number, pin_headphone_node_number); //initalize headphone output
   hda_pin_headphone_node_number = pin_headphone_node_number; //save headphone node number

   //if first path and second path share nodes, left only info for first path
   if(hda_audio_output_node_number==hda_second_audio_output_node_number) {
    hda_second_audio_output_node_number = 0;
   }
   if(hda_output_amp_node_number==hda_second_output_amp_node_number) {
    hda_second_output_amp_node_number = 0;
   }

   //find headphone connection status
   if(hda_is_headphone_connected()==STATUS_TRUE) {
    hda_disable_pin_output(hda_codec_number, hda_pin_output_node_number);
    hda_selected_output_node = hda_pin_headphone_node_number;
   }
   else {
    hda_selected_output_node = hda_pin_output_node_number;
   }

   //add task for checking headphone connection
   create_task(hda_check_headphone_connection_change, TASK_TYPE_USER_INPUT, 50);
  }
 }
 else if(pin_headphone_node_number!=0) { //codec do not have speaker, but only headphone output
  log("\nHeadphone output");
  hda_is_initalized_useful_output = STATUS_TRUE;
  hda_initalize_output_pin(sound_card_number, pin_headphone_node_number); //initalize headphone output
  hda_pin_output_node_number = pin_headphone_node_number; //save headphone node number
 }
 else if(pin_alternative_output_node_number!=0) { //codec have only alternative output
  log("\nAlternative output");
  hda_is_initalized_useful_output = STATUS_FALSE;
  hda_initalize_output_pin(sound_card_number, pin_alternative_output_node_number); //initalize alternative output
  hda_pin_output_node_number = pin_alternative_output_node_number; //save alternative output node number
 }
 else {
  log("\nCodec do not have any output PINs");
 }
}

void hda_initalize_output_pin(dword_t sound_card_number, dword_t pin_node_number) {
 log("\nInitalizing PIN ");
 log_var(pin_node_number);

 //reset variables of first path
 hda_audio_output_node_number = 0;
 hda_audio_output_node_sample_capabilities = 0;
 hda_audio_output_node_stream_format_capabilities = 0;
 hda_output_amp_node_number = 0;
 hda_output_amp_node_capabilities = 0;

 //turn on power for PIN
 hda_send_verb(hda_codec_number, pin_node_number, 0x705, 0x00);

 //disable unsolicited responses
 hda_send_verb(hda_codec_number, pin_node_number, 0x708, 0x00);

 //disable any processing
 hda_send_verb(hda_codec_number, pin_node_number, 0x703, 0x00);

 //enable PIN
 hda_send_verb(hda_codec_number, pin_node_number, 0x707, (hda_send_verb(hda_codec_number, pin_node_number, 0xF07, 0x00) | 0x80 | 0x40));

 //enable EAPD + L-R swap
 hda_send_verb(hda_codec_number, pin_node_number, 0x70C, 0x6);

 //set maximal volume for PIN
 dword_t pin_output_amp_capabilities = hda_send_verb(hda_codec_number, pin_node_number, 0xF00, 0x12);
 hda_set_node_gain(hda_codec_number, pin_node_number, HDA_OUTPUT_NODE, pin_output_amp_capabilities, 100);
 if(pin_output_amp_capabilities!=0) {
  //we will control volume by PIN node
  hda_output_amp_node_number = pin_node_number;
  hda_output_amp_node_capabilities = pin_output_amp_capabilities;
 }

 //start enabling path of nodes
 hda_length_of_node_path = 0;
 hda_send_verb(hda_codec_number, pin_node_number, 0x701, 0x00); //select first node
 dword_t first_connected_node_number = hda_get_node_connection_entry(hda_codec_number, pin_node_number, 0); //get first node number
 dword_t type_of_first_connected_node = hda_get_node_type(hda_codec_number, first_connected_node_number); //get type of first node
 if(type_of_first_connected_node==HDA_WIDGET_AUDIO_OUTPUT) {
  hda_initalize_audio_output(sound_card_number, first_connected_node_number);
 }
 else if(type_of_first_connected_node==HDA_WIDGET_AUDIO_MIXER) {
  hda_initalize_audio_mixer(sound_card_number, first_connected_node_number);
 }
 else if(type_of_first_connected_node==HDA_WIDGET_AUDIO_SELECTOR) {
  hda_initalize_audio_selector(sound_card_number, first_connected_node_number);
 }
 else {
  log("\nHDA ERROR: PIN have connection ");
  log_var(first_connected_node_number);
 }
}

void hda_initalize_audio_output(dword_t sound_card_number, dword_t audio_output_node_number) {
 log("\nInitalizing Audio Output ");
 log_var(audio_output_node_number);
 hda_audio_output_node_number = audio_output_node_number;

 //turn on power for Audio Output
 hda_send_verb(hda_codec_number, audio_output_node_number, 0x705, 0x00);

 //disable unsolicited responses
 hda_send_verb(hda_codec_number, audio_output_node_number, 0x708, 0x00);

 //disable any processing
 hda_send_verb(hda_codec_number, audio_output_node_number, 0x703, 0x00);

 //connect Audio Output to stream 1 channel 0
 hda_send_verb(hda_codec_number, audio_output_node_number, 0x706, 0x10);

 //set maximal volume for Audio Output
 dword_t audio_output_amp_capabilities = hda_send_verb(hda_codec_number, audio_output_node_number, 0xF00, 0x12);
 hda_set_node_gain(hda_codec_number, audio_output_node_number, HDA_OUTPUT_NODE, audio_output_amp_capabilities, 100);
 if(audio_output_amp_capabilities!=0) {
  //we will control volume by Audio Output node
  hda_output_amp_node_number = audio_output_node_number;
  hda_output_amp_node_capabilities = audio_output_amp_capabilities;
 }

 //read info, if something is not present, take it from AFG node
 dword_t audio_output_sample_capabilities = hda_send_verb(hda_codec_number, audio_output_node_number, 0xF00, 0x0A);
 if(audio_output_sample_capabilities==0) {
  hda_audio_output_node_sample_capabilities = hda_afg_node_sample_capabilities;
 }
 else {
  hda_audio_output_node_sample_capabilities = audio_output_sample_capabilities;
 }
 dword_t audio_output_stream_format_capabilities = hda_send_verb(hda_codec_number, audio_output_node_number, 0xF00, 0x0B);
 if(audio_output_stream_format_capabilities==0) {
  hda_audio_output_node_stream_format_capabilities = hda_afg_node_stream_format_capabilities;
 }
 else {
  hda_audio_output_node_stream_format_capabilities = audio_output_stream_format_capabilities;
 }
 if(hda_output_amp_node_number==0) { //if nodes in path do not have output amp capabilities, volume will be controlled by Audio Output node with capabilities taken from AFG node
  hda_output_amp_node_number = audio_output_node_number;
  hda_output_amp_node_capabilities = hda_afg_node_output_amp_capabilities;
 }

 //because we are at end of node path, log all gathered info
 log("\nSample Capabilites: ");
 log_hex(hda_audio_output_node_sample_capabilities);
 log("\nStream Format Capabilites: ");
 log_hex(hda_audio_output_node_stream_format_capabilities);
 log("\nVolume node: ");
 log_var(hda_output_amp_node_number);
 log("\nVolume capabilities: ");
 log_hex(hda_output_amp_node_capabilities);
}

void hda_initalize_audio_mixer(dword_t sound_card_number, dword_t audio_mixer_node_number) {
 if(hda_length_of_node_path>=10) {
  log("\nHDA ERROR: too long path");
  return;
 }
 log("\nInitalizing Audio Mixer ");
 log_var(audio_mixer_node_number);

 //turn on power for Audio Mixer
 hda_send_verb(hda_codec_number, audio_mixer_node_number, 0x705, 0x00);

 //disable unsolicited responses
 hda_send_verb(hda_codec_number, audio_mixer_node_number, 0x708, 0x00);

 //set maximal volume for Audio Mixer
 dword_t audio_mixer_amp_capabilities = hda_send_verb(hda_codec_number, audio_mixer_node_number, 0xF00, 0x12);
 hda_set_node_gain(hda_codec_number, audio_mixer_node_number, HDA_OUTPUT_NODE, audio_mixer_amp_capabilities, 100);
 if(audio_mixer_amp_capabilities!=0) {
  //we will control volume by Audio Mixer node
  hda_output_amp_node_number = audio_mixer_node_number;
  hda_output_amp_node_capabilities = audio_mixer_amp_capabilities;
 }

 //continue in path
 hda_length_of_node_path++;
 dword_t first_connected_node_number = hda_get_node_connection_entry(hda_codec_number, audio_mixer_node_number, 0); //get first node number
 dword_t type_of_first_connected_node = hda_get_node_type(hda_codec_number, first_connected_node_number); //get type of first node
 if(type_of_first_connected_node==HDA_WIDGET_AUDIO_OUTPUT) {
  hda_initalize_audio_output(sound_card_number, first_connected_node_number);
 }
 else if(type_of_first_connected_node==HDA_WIDGET_AUDIO_MIXER) {
  hda_initalize_audio_mixer(sound_card_number, first_connected_node_number);
 }
 else if(type_of_first_connected_node==HDA_WIDGET_AUDIO_SELECTOR) {
  hda_initalize_audio_selector(sound_card_number, first_connected_node_number);
 }
 else {
  log("\nHDA ERROR: Mixer have connection ");
  log_var(first_connected_node_number);
 }
}

void hda_initalize_audio_selector(dword_t sound_card_number, dword_t audio_selector_node_number) {
 if(hda_length_of_node_path>=10) {
  log("\nHDA ERROR: too long path");
  return;
 }
 log("\nInitalizing Audio Selector ");
 log_var(audio_selector_node_number);

 //turn on power for Audio Selector
 hda_send_verb(hda_codec_number, audio_selector_node_number, 0x705, 0x00);

 //disable unsolicited responses
 hda_send_verb(hda_codec_number, audio_selector_node_number, 0x708, 0x00);

 //disable any processing
 hda_send_verb(hda_codec_number, audio_selector_node_number, 0x703, 0x00);

 //set maximal volume for Audio Selector
 dword_t audio_selector_amp_capabilities = hda_send_verb(hda_codec_number, audio_selector_node_number, 0xF00, 0x12);
 hda_set_node_gain(hda_codec_number, audio_selector_node_number, HDA_OUTPUT_NODE, audio_selector_amp_capabilities, 100);
 if(audio_selector_amp_capabilities!=0) {
  //we will control volume by Audio Selector node
  hda_output_amp_node_number = audio_selector_node_number;
  hda_output_amp_node_capabilities = audio_selector_amp_capabilities;
 }

 //continue in path
 hda_length_of_node_path++;
 hda_send_verb(hda_codec_number, audio_selector_node_number, 0x701, 0x00); //select first node
 dword_t first_connected_node_number = hda_get_node_connection_entry(hda_codec_number, audio_selector_node_number, 0); //get first node number
 dword_t type_of_first_connected_node = hda_get_node_type(hda_codec_number, first_connected_node_number); //get type of first node
 if(type_of_first_connected_node==HDA_WIDGET_AUDIO_OUTPUT) {
  hda_initalize_audio_output(sound_card_number, first_connected_node_number);
 }
 else if(type_of_first_connected_node==HDA_WIDGET_AUDIO_MIXER) {
  hda_initalize_audio_mixer(sound_card_number, first_connected_node_number);
 }
 else if(type_of_first_connected_node==HDA_WIDGET_AUDIO_SELECTOR) {
  hda_initalize_audio_selector(sound_card_number, first_connected_node_number);
 }
 else {
  log("\nHDA ERROR: Selector have connection ");
  log_var(first_connected_node_number);
 }
}

void hda_set_volume(dword_t sound_card_number, dword_t volume) {
 hda_set_node_gain(hda_codec_number, hda_output_amp_node_number, HDA_OUTPUT_NODE, hda_output_amp_node_capabilities, volume);
 if(hda_second_output_amp_node_number!=0) {
  hda_set_node_gain(hda_codec_number, hda_second_output_amp_node_number, HDA_OUTPUT_NODE, hda_second_output_amp_node_capabilities, volume);
 }
}

void hda_check_headphone_connection_change(void) {
 if(hda_selected_output_node==hda_pin_output_node_number && hda_is_headphone_connected()==STATUS_TRUE) { //headphone was connected
  hda_disable_pin_output(hda_codec_number, hda_pin_output_node_number);
  hda_selected_output_node = hda_pin_headphone_node_number;
 }
 else if(hda_selected_output_node==hda_pin_headphone_node_number && hda_is_headphone_connected()==STATUS_FALSE) { //headphone was disconnected
  hda_enable_pin_output(hda_codec_number, hda_pin_output_node_number);
  hda_selected_output_node = hda_pin_output_node_number;
 }
}

byte_t hda_is_supported_channel_size(dword_t sound_card_number, byte_t size) {
 byte_t channel_sizes[5] = {8, 16, 20, 24, 32};
 dword_t mask=0x00010000;
 
 //get bit of requested size in capabilities
 for(int i=0; i<5; i++) {
  if(channel_sizes[i]==size) {
   break;
  }
  mask <<= 1;
 }
 
 if((hda_audio_output_node_sample_capabilities & mask)==mask) {
  return STATUS_GOOD;
 }
 else {
  return STATUS_ERROR;
 }
}

byte_t hda_is_supported_sample_rate(dword_t sound_card_number, dword_t sample_rate) {
 dword_t sample_rates[11] = {8000, 11025, 16000, 22050, 32000, 44100, 48000, 88200, 96000, 176400, 192000};
 word_t mask=0x0000001;
 
 //get bit of requested sample rate in capabilities
 for(int i=0; i<11; i++) {
  if(sample_rates[i]==sample_rate) {
   break;
  }
  mask <<= 1;
 }
 
 if((hda_audio_output_node_sample_capabilities & mask)==mask) {
  return STATUS_GOOD;
 }
 else {
  return STATUS_ERROR;
 }
}

word_t hda_return_sound_data_format(dword_t sample_rate, dword_t channels, dword_t bits_per_sample) {
 word_t data_format = 0;

 //channels
 data_format = (channels-1);

 //bits per sample
 if(bits_per_sample==16) {
  data_format |= ((0b001)<<4);
 }
 else if(bits_per_sample==20) {
  data_format |= ((0b010)<<4);
 }
 else if(bits_per_sample==24) {
  data_format |= ((0b011)<<4);
 }
 else if(bits_per_sample==32) {
  data_format |= ((0b100)<<4);
 }

 //sample rate
 if(sample_rate==48000) {
  data_format |= ((0b0000000)<<8);
 }
 else if(sample_rate==44100) {
  data_format |= ((0b1000000)<<8);
 }
 else if(sample_rate==32000) {
  data_format |= ((0b0001010)<<8);
 }
 else if(sample_rate==22050) {
  data_format |= ((0b1000001)<<8);
 }
 else if(sample_rate==16000) {
  data_format |= ((0b0000010)<<8);
 }
 else if(sample_rate==11025) {
  data_format |= ((0b1000011)<<8);
 }
 else if(sample_rate==8000) {
  data_format |= ((0b0000101)<<8);
 }
 else if(sample_rate==88200) {
  data_format |= ((0b1001000)<<8);
 }
 else if(sample_rate==96000) {
  data_format |= ((0b0001000)<<8);
 }
 else if(sample_rate==176400) {
  data_format |= ((0b1011000)<<8);
 }
 else if(sample_rate==192000) {
  data_format |= ((0b0011000)<<8);
 }

 return data_format;
}

void hda_play_memory(dword_t sound_card_number, dword_t memory, dword_t sample_rate, dword_t channels, dword_t bits_per_sample, dword_t number_of_samples_in_one_channel) {
 if((hda_audio_output_node_stream_format_capabilities & 0x1)==0x0) {
  return; //this Audio Output do not support PCM sound data
 }

 //calculate length of data in bytes
 dword_t bytes_per_sample = (bits_per_sample/8); //8 bits/16 bits
 if(bits_per_sample>16) { //20 bits/24 bits/32 bits
  bytes_per_sample = 4;
 }
 hda_sound_length = (number_of_samples_in_one_channel*bytes_per_sample*channels);

 //stop stream
 hda_playing_state = 0;
 mmio_outb(hda_output_stream_base + 0x00, 0x00);
 ticks = 0;
 while(ticks<2) {
  asm("nop");
  if((mmio_inb(hda_output_stream_base + 0x00) & 0x2)==0x0) {
   break;
  }
 }
 if((mmio_inb(hda_output_stream_base + 0x00) & 0x2)==0x2) {
  log("\nHDA: can not stop stream");
  return;
 }
 
 //reset stream registers
 mmio_outb(hda_output_stream_base + 0x00, 0x01);
 ticks = 0;
 while(ticks<10) {
  asm("nop");
  if((mmio_inb(hda_output_stream_base + 0x00) & 0x1)==0x1) {
   break;
  }
 }
 if((mmio_inb(hda_output_stream_base + 0x00) & 0x1)==0x0) {
  log("\nHDA: can not start resetting stream");
 }
 wait(5);
 mmio_outb(hda_output_stream_base + 0x00, 0x00);
 ticks = 0;
 while(ticks<10) {
  asm("nop");
  if((mmio_inb(hda_output_stream_base + 0x00) & 0x1)==0x0) {
   break;
  }
 }
 if((mmio_inb(hda_output_stream_base + 0x00) & 0x1)==0x1) {
  log("\nHDA: can not stop resetting stream");
  return;
 }
 wait(5);

 //clear error bits
 mmio_outb(hda_output_stream_base + 0x03, 0x1C);

 //fill buffer entries - there have to be at least two entries in buffer, so we fill second entry with zeroes
 clear_memory((dword_t)hda_output_buffer_list, 16*2);
 hda_output_buffer_list[0]=memory;
 hda_output_buffer_list[2]=hda_sound_length;
 asm("wbinvd"); //flush processor cache to RAM to be sure sound card will read correct data

 //set buffer registers
 mmio_outd(hda_output_stream_base + 0x18, (dword_t)hda_output_buffer_list);
 mmio_outd(hda_output_stream_base + 0x08, hda_sound_length);
 mmio_outw(hda_output_stream_base + 0x0C, 1); //there are two entries in buffer

 //set stream data format
 mmio_outw(hda_output_stream_base + 0x12, hda_return_sound_data_format(sample_rate, channels, bits_per_sample));

 //set Audio Output node data format
 hda_send_verb(hda_codec_number, hda_audio_output_node_number, 0x200, hda_return_sound_data_format(sample_rate, channels, bits_per_sample));
 if(hda_second_audio_output_node_number!=0) {
  hda_send_verb(hda_codec_number, hda_second_audio_output_node_number, 0x200, hda_return_sound_data_format(sample_rate, channels, bits_per_sample));
 }
 wait(10);

 //start streaming to stream 1
 mmio_outb(hda_output_stream_base + 0x02, 0x14);
 mmio_outb(hda_output_stream_base + 0x00, 0x02);
 hda_bytes_on_output_for_stopping_sound = 0;
 hda_playing_state = 1;

 //sound will be automatically stopped by drivers/system/processes_on_background.c
}

void hda_stop_sound(dword_t sound_card_number) {
 mmio_outb(hda_output_stream_base + 0x00, 0x00);
 hda_playing_state = 0;
}

void hda_resume_sound(dword_t sound_card_number) {
 mmio_outb(hda_output_stream_base + 0x00, 0x02);
 hda_playing_state = 1;
}