deac/osd-contiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
osd-contiki/cpu/x86/init/common/interrupt.h

107 lines
4.7 KiB
C
Raw Normal View History

x86: Introduce interrupt.h This patch introduces the interrupt.h header file which provides some helper macros to set a interrupt handler and disable/enable maskable hardware interrupts. Since there is no easy way to write an Interrupt Service Routines (ISR) in C (for further information on this, see [1]), we introduce the SET_INTERRUPT_HANDLER helper macro. The macro does two things: 1) Defines an assembly trampolin to a C function that will, indeed, handle the interrupt. 2) Sets the corresponding interrupt gate descriptor in IDT. The macro usage is pretty straightforward. The macro is defined as SET_INTERRUPT_HANDLER(num, has_error_code, handler) where: @num: Interrupt number (0-255) @has_error_code: 0 if processor doesn't push error code onto the stack. Otherwise, set this argument to 1. @handler: Pointer to function that should be called once the interrupt is raised. In case has_error_code == 0 the function prototype should be the following: void handler(void) Otherwise, it should be: void handler(struct interrupt_context context) For instance, let's say we want to set a handler for a device interrupt (for example, interrupt number 101). Remember, hardware interrupts don't have error code. So we should have something like this: void interrupt_handler(void) { /* Handling code here */ } void my_device_init(void) { ... SET_INTERRUPT_HANDLER(101, 0, interrupt_handler); ... } Now, let's say we want to set an interrupt handler for Page Fault (interrupt number 14). Some exceptions, such as Page Fault, pushes an error code onto the stack and may require registers values in order to be properly be handled. Thus, the code should look like this: void pagefault_handler(struct interrupt_context context) { /* Handling code here */ } void init_memory(void) { ... SET_INTERRUPT_HANDLER(14, 1, pagefault_handler); ... } For further information about exceptions and error code, refer to Intel Combined Manual, Vol. 3, Sections 6.3 and 6.13. Finally, we don't define any API to unregister interrupt handlers since we believe that it wouldn't be useful at all, at least at this moment. Considering Contiki's context, interrupt handler registration is pretty "static" and defined at compile-time by platform code (or the device drivers used by the platform). [1] http://wiki.osdev.org/Interrupt_Service_Routines
2015-04-15 20:05:12 +02:00
/*
* Copyright (C) 2015, Intel Corporation. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* 3. Neither the name of the copyright holder nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef INTERRUPT_H
#define INTERRUPT_H
#include <stdint.h>
#include "idt.h"
struct interrupt_context {
uint32_t edi;
uint32_t esi;
uint32_t ebp;
uint32_t esp;
uint32_t ebx;
uint32_t edx;
uint32_t ecx;
uint32_t eax;
uint32_t error_code;
uint32_t eip;
};
/* Helper macro to register interrupt handler function.
*
* num: Interrupt number (0-255)
* has_error_code: 0 if interrupt doesn't push error code onto the
* stack. Otherwise, set this argument to 1.
* handler: Pointer to function that should be called once the
* interrupt is raised. In case has_error_code == 0
* the function prototype should be the following:
* void handler(void)
* Otherwise, it should be:
* void handler(struct interrupt_context context)
*
* Since there is no easy way to write an Interrupt Service Routines
* (ISR) in C (for further information on this, see [1]), we provide
* this helper macro. It basically provides an assembly trampoline
* to a C function (handler parameter) which, indeed, handles the
* interrupt.
*
* [1] http://wiki.osdev.org/Interrupt_Service_Routines
*/
#define SET_INTERRUPT_HANDLER(num, has_error_code, handler) \
do { \
__asm__ __volatile__ ( \
x86: Revise SET_INTERRUPT_HANDLER to avoid using inline assembly feature that does not work with LLVM Clang The SET_INTERRUPT_HANDLER macro in interrupt.h used an inline assembly feature to cause GCC to generate a unique number for a trampoline label. Clang compiled the code using that feature without generating any compile-time errors, but it always generated the number 0, resulting in all interrupt trampolines having the same label names. This patch replaces the usage of that feature with local labels, which are supported by both GCC and Clang. See https://sourceware.org/binutils/docs/as/Symbol-Names.html for an explanation of local labels.
2015-07-29 16:21:55 +02:00
"push $1f\n\t" \
x86: Introduce interrupt.h This patch introduces the interrupt.h header file which provides some helper macros to set a interrupt handler and disable/enable maskable hardware interrupts. Since there is no easy way to write an Interrupt Service Routines (ISR) in C (for further information on this, see [1]), we introduce the SET_INTERRUPT_HANDLER helper macro. The macro does two things: 1) Defines an assembly trampolin to a C function that will, indeed, handle the interrupt. 2) Sets the corresponding interrupt gate descriptor in IDT. The macro usage is pretty straightforward. The macro is defined as SET_INTERRUPT_HANDLER(num, has_error_code, handler) where: @num: Interrupt number (0-255) @has_error_code: 0 if processor doesn't push error code onto the stack. Otherwise, set this argument to 1. @handler: Pointer to function that should be called once the interrupt is raised. In case has_error_code == 0 the function prototype should be the following: void handler(void) Otherwise, it should be: void handler(struct interrupt_context context) For instance, let's say we want to set a handler for a device interrupt (for example, interrupt number 101). Remember, hardware interrupts don't have error code. So we should have something like this: void interrupt_handler(void) { /* Handling code here */ } void my_device_init(void) { ... SET_INTERRUPT_HANDLER(101, 0, interrupt_handler); ... } Now, let's say we want to set an interrupt handler for Page Fault (interrupt number 14). Some exceptions, such as Page Fault, pushes an error code onto the stack and may require registers values in order to be properly be handled. Thus, the code should look like this: void pagefault_handler(struct interrupt_context context) { /* Handling code here */ } void init_memory(void) { ... SET_INTERRUPT_HANDLER(14, 1, pagefault_handler); ... } For further information about exceptions and error code, refer to Intel Combined Manual, Vol. 3, Sections 6.3 and 6.13. Finally, we don't define any API to unregister interrupt handlers since we believe that it wouldn't be useful at all, at least at this moment. Considering Contiki's context, interrupt handler registration is pretty "static" and defined at compile-time by platform code (or the device drivers used by the platform). [1] http://wiki.osdev.org/Interrupt_Service_Routines
2015-04-15 20:05:12 +02:00
"push %0\n\t" \
"call %P1\n\t" \
"add $8, %%esp\n\t" \
x86: Revise SET_INTERRUPT_HANDLER to avoid using inline assembly feature that does not work with LLVM Clang The SET_INTERRUPT_HANDLER macro in interrupt.h used an inline assembly feature to cause GCC to generate a unique number for a trampoline label. Clang compiled the code using that feature without generating any compile-time errors, but it always generated the number 0, resulting in all interrupt trampolines having the same label names. This patch replaces the usage of that feature with local labels, which are supported by both GCC and Clang. See https://sourceware.org/binutils/docs/as/Symbol-Names.html for an explanation of local labels.
2015-07-29 16:21:55 +02:00
"jmp 2f\n\t" \
x86: Introduce interrupt.h This patch introduces the interrupt.h header file which provides some helper macros to set a interrupt handler and disable/enable maskable hardware interrupts. Since there is no easy way to write an Interrupt Service Routines (ISR) in C (for further information on this, see [1]), we introduce the SET_INTERRUPT_HANDLER helper macro. The macro does two things: 1) Defines an assembly trampolin to a C function that will, indeed, handle the interrupt. 2) Sets the corresponding interrupt gate descriptor in IDT. The macro usage is pretty straightforward. The macro is defined as SET_INTERRUPT_HANDLER(num, has_error_code, handler) where: @num: Interrupt number (0-255) @has_error_code: 0 if processor doesn't push error code onto the stack. Otherwise, set this argument to 1. @handler: Pointer to function that should be called once the interrupt is raised. In case has_error_code == 0 the function prototype should be the following: void handler(void) Otherwise, it should be: void handler(struct interrupt_context context) For instance, let's say we want to set a handler for a device interrupt (for example, interrupt number 101). Remember, hardware interrupts don't have error code. So we should have something like this: void interrupt_handler(void) { /* Handling code here */ } void my_device_init(void) { ... SET_INTERRUPT_HANDLER(101, 0, interrupt_handler); ... } Now, let's say we want to set an interrupt handler for Page Fault (interrupt number 14). Some exceptions, such as Page Fault, pushes an error code onto the stack and may require registers values in order to be properly be handled. Thus, the code should look like this: void pagefault_handler(struct interrupt_context context) { /* Handling code here */ } void init_memory(void) { ... SET_INTERRUPT_HANDLER(14, 1, pagefault_handler); ... } For further information about exceptions and error code, refer to Intel Combined Manual, Vol. 3, Sections 6.3 and 6.13. Finally, we don't define any API to unregister interrupt handlers since we believe that it wouldn't be useful at all, at least at this moment. Considering Contiki's context, interrupt handler registration is pretty "static" and defined at compile-time by platform code (or the device drivers used by the platform). [1] http://wiki.osdev.org/Interrupt_Service_Routines
2015-04-15 20:05:12 +02:00
".align 4\n\t" \
x86: Revise SET_INTERRUPT_HANDLER to avoid using inline assembly feature that does not work with LLVM Clang The SET_INTERRUPT_HANDLER macro in interrupt.h used an inline assembly feature to cause GCC to generate a unique number for a trampoline label. Clang compiled the code using that feature without generating any compile-time errors, but it always generated the number 0, resulting in all interrupt trampolines having the same label names. This patch replaces the usage of that feature with local labels, which are supported by both GCC and Clang. See https://sourceware.org/binutils/docs/as/Symbol-Names.html for an explanation of local labels.
2015-07-29 16:21:55 +02:00
"1:\n\t" \
x86: Introduce interrupt.h This patch introduces the interrupt.h header file which provides some helper macros to set a interrupt handler and disable/enable maskable hardware interrupts. Since there is no easy way to write an Interrupt Service Routines (ISR) in C (for further information on this, see [1]), we introduce the SET_INTERRUPT_HANDLER helper macro. The macro does two things: 1) Defines an assembly trampolin to a C function that will, indeed, handle the interrupt. 2) Sets the corresponding interrupt gate descriptor in IDT. The macro usage is pretty straightforward. The macro is defined as SET_INTERRUPT_HANDLER(num, has_error_code, handler) where: @num: Interrupt number (0-255) @has_error_code: 0 if processor doesn't push error code onto the stack. Otherwise, set this argument to 1. @handler: Pointer to function that should be called once the interrupt is raised. In case has_error_code == 0 the function prototype should be the following: void handler(void) Otherwise, it should be: void handler(struct interrupt_context context) For instance, let's say we want to set a handler for a device interrupt (for example, interrupt number 101). Remember, hardware interrupts don't have error code. So we should have something like this: void interrupt_handler(void) { /* Handling code here */ } void my_device_init(void) { ... SET_INTERRUPT_HANDLER(101, 0, interrupt_handler); ... } Now, let's say we want to set an interrupt handler for Page Fault (interrupt number 14). Some exceptions, such as Page Fault, pushes an error code onto the stack and may require registers values in order to be properly be handled. Thus, the code should look like this: void pagefault_handler(struct interrupt_context context) { /* Handling code here */ } void init_memory(void) { ... SET_INTERRUPT_HANDLER(14, 1, pagefault_handler); ... } For further information about exceptions and error code, refer to Intel Combined Manual, Vol. 3, Sections 6.3 and 6.13. Finally, we don't define any API to unregister interrupt handlers since we believe that it wouldn't be useful at all, at least at this moment. Considering Contiki's context, interrupt handler registration is pretty "static" and defined at compile-time by platform code (or the device drivers used by the platform). [1] http://wiki.osdev.org/Interrupt_Service_Routines
2015-04-15 20:05:12 +02:00
" pushal\n\t" \
" call %P2\n\t" \
" popal\n\t" \
" .if " #has_error_code "\n\t" \
" add $4, %%esp\n\t" \
" .endif\n\t" \
" iret\n\t" \
x86: Revise SET_INTERRUPT_HANDLER to avoid using inline assembly feature that does not work with LLVM Clang The SET_INTERRUPT_HANDLER macro in interrupt.h used an inline assembly feature to cause GCC to generate a unique number for a trampoline label. Clang compiled the code using that feature without generating any compile-time errors, but it always generated the number 0, resulting in all interrupt trampolines having the same label names. This patch replaces the usage of that feature with local labels, which are supported by both GCC and Clang. See https://sourceware.org/binutils/docs/as/Symbol-Names.html for an explanation of local labels.
2015-07-29 16:21:55 +02:00
"2:\n\t" \
x86: Introduce interrupt.h This patch introduces the interrupt.h header file which provides some helper macros to set a interrupt handler and disable/enable maskable hardware interrupts. Since there is no easy way to write an Interrupt Service Routines (ISR) in C (for further information on this, see [1]), we introduce the SET_INTERRUPT_HANDLER helper macro. The macro does two things: 1) Defines an assembly trampolin to a C function that will, indeed, handle the interrupt. 2) Sets the corresponding interrupt gate descriptor in IDT. The macro usage is pretty straightforward. The macro is defined as SET_INTERRUPT_HANDLER(num, has_error_code, handler) where: @num: Interrupt number (0-255) @has_error_code: 0 if processor doesn't push error code onto the stack. Otherwise, set this argument to 1. @handler: Pointer to function that should be called once the interrupt is raised. In case has_error_code == 0 the function prototype should be the following: void handler(void) Otherwise, it should be: void handler(struct interrupt_context context) For instance, let's say we want to set a handler for a device interrupt (for example, interrupt number 101). Remember, hardware interrupts don't have error code. So we should have something like this: void interrupt_handler(void) { /* Handling code here */ } void my_device_init(void) { ... SET_INTERRUPT_HANDLER(101, 0, interrupt_handler); ... } Now, let's say we want to set an interrupt handler for Page Fault (interrupt number 14). Some exceptions, such as Page Fault, pushes an error code onto the stack and may require registers values in order to be properly be handled. Thus, the code should look like this: void pagefault_handler(struct interrupt_context context) { /* Handling code here */ } void init_memory(void) { ... SET_INTERRUPT_HANDLER(14, 1, pagefault_handler); ... } For further information about exceptions and error code, refer to Intel Combined Manual, Vol. 3, Sections 6.3 and 6.13. Finally, we don't define any API to unregister interrupt handlers since we believe that it wouldn't be useful at all, at least at this moment. Considering Contiki's context, interrupt handler registration is pretty "static" and defined at compile-time by platform code (or the device drivers used by the platform). [1] http://wiki.osdev.org/Interrupt_Service_Routines
2015-04-15 20:05:12 +02:00
:: "g" (num), "i" (idt_set_intr_gate_desc), "i" (handler) \
x86: Add missing clobber list in interrupt.h The SET_INTERRUPT_HANDLER macro defines and registers an interrupt handler. It outputs a trampoline for the interrupt handler using a block of inline assembly, and the address of that trampoline is what is actually placed in the IDT. That trampoline invokes the main body of the interrupt handler. This patch adds a missing clobber list to the inline assembly block. It simply lists the caller-saved registers defined by the cdecl calling convention: EAX, ECX, and EDX. This is necessary, because the inline assembly block invokes idt_set_intr_gate_desc using a call instruction at the time the function containing the SET_INTERRUPT_HANDLER instance is executed. The idt_set_intr_gate_desc function is free to clobber EAX, ECX, and EDX according to cdecl. A Clang-generated implementation of idt_set_intr_gate_desc did in fact clobber those registers, resulting in incorrect operation of the code following an instance of SET_INTERRUPT_HANDLER. The change in this patch informs the compiler that those registers may be clobbered so that it can adjust the code that it outputs around the inline assembly block accordingly.
2015-07-29 16:00:54 +02:00
: "eax", "ecx", "edx" \
x86: Introduce interrupt.h This patch introduces the interrupt.h header file which provides some helper macros to set a interrupt handler and disable/enable maskable hardware interrupts. Since there is no easy way to write an Interrupt Service Routines (ISR) in C (for further information on this, see [1]), we introduce the SET_INTERRUPT_HANDLER helper macro. The macro does two things: 1) Defines an assembly trampolin to a C function that will, indeed, handle the interrupt. 2) Sets the corresponding interrupt gate descriptor in IDT. The macro usage is pretty straightforward. The macro is defined as SET_INTERRUPT_HANDLER(num, has_error_code, handler) where: @num: Interrupt number (0-255) @has_error_code: 0 if processor doesn't push error code onto the stack. Otherwise, set this argument to 1. @handler: Pointer to function that should be called once the interrupt is raised. In case has_error_code == 0 the function prototype should be the following: void handler(void) Otherwise, it should be: void handler(struct interrupt_context context) For instance, let's say we want to set a handler for a device interrupt (for example, interrupt number 101). Remember, hardware interrupts don't have error code. So we should have something like this: void interrupt_handler(void) { /* Handling code here */ } void my_device_init(void) { ... SET_INTERRUPT_HANDLER(101, 0, interrupt_handler); ... } Now, let's say we want to set an interrupt handler for Page Fault (interrupt number 14). Some exceptions, such as Page Fault, pushes an error code onto the stack and may require registers values in order to be properly be handled. Thus, the code should look like this: void pagefault_handler(struct interrupt_context context) { /* Handling code here */ } void init_memory(void) { ... SET_INTERRUPT_HANDLER(14, 1, pagefault_handler); ... } For further information about exceptions and error code, refer to Intel Combined Manual, Vol. 3, Sections 6.3 and 6.13. Finally, we don't define any API to unregister interrupt handlers since we believe that it wouldn't be useful at all, at least at this moment. Considering Contiki's context, interrupt handler registration is pretty "static" and defined at compile-time by platform code (or the device drivers used by the platform). [1] http://wiki.osdev.org/Interrupt_Service_Routines
2015-04-15 20:05:12 +02:00
); \
} while (0)
/* Disable maskable hardware interrupts */
#define DISABLE_IRQ() \
do { \
__asm__ ("cli"); \
} while (0)
/* Enable maskable hardware interrupts */
#define ENABLE_IRQ() \
do { \
__asm__ ("sti"); \
} while (0)
#endif /* INTERRUPT_H */
Reference in a new issue Copy permalink