system/include/ke/apic.h

   1 /*
   2 Copyright (C) 2008  Mathias Gottschlag
   3
   4 Permission is hereby granted, free of charge, to any person obtaining a copy of
   5 this software and associated documentation files (the "Software"), to deal in the
   6 Software without restriction, including without limitation the rights to use,
   7 copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
   8 Software, and to permit persons to whom the Software is furnished to do so,
   9 subject to the following conditions:
  10
  11 The above copyright notice and this permission notice shall be included in all
  12 copies or substantial portions of the Software.
  13
  14 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  15 INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  16 PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  17 HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  18 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  19 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  20 */
  21 /**
  22  * \file apic.h
  23  * Advanced programmable interrupt controller
  24  */
  25
  26 #ifndef KE_APIC_H_INCLUDED
  27 #define KE_APIC_H_INCLUDED
  28
  29 #include <stdint.h>
  30
  31 /**
  32  * Initialized the APIC. Is called by the operating system at startup.
  33  */
  34 int keAPICInit(void);
  35
  36 /**
  37  * Returns the APIC ID of the current CPU.
  38  */
  39 uint32_t keAPICGetCPU(void);
  40
  41 /**
  42  * Writes into an APIC register.
  43  */
  44 void keAPICWrite(uint16_t offset, uint32_t value);
  45 /**
  46  * Reads from an APIC register.
  47  */
  48 uint32_t keAPICRead(uint16_t offset);
  49 /**
  50  * Send an INIT IPI to all CPUs but the currently used.
  51  */
  52 void keAPICWriteInit(void);
  53 /**
  54  * Send a STARTUP IPI to all CPUs but the currently used.
  55  */
  56 void keAPICWriteStartup(uintptr_t entry);
  57 /**
  58  * Sends a custom IPI.
  59  * \param intno Interrupt to be triggered.
  60  * \param self If set to 1, include currently used CPU.
  61  */
  62 void keAPICBroadcast(uint8_t intno, int self);
  63
  64 #endif
  65