OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity
acrn-hypervisor/hypervisor/include/common/irq.h

78 lines
2.0 KiB
C
Raw Normal View History

hv: pirq: add a header for common data struct and APIs - add a commont head file include/common/irq.h, to include the common data structure and APIs; - move the common data struct and APIs from arch/x86/irq.h to the common header. Signed-off-by: Yan, Like <like.yan@intel.com> Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-06-20 16:30:55 +08:00
/*
* Copyright (C) 2018 Intel Corporation. All rights reserved.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
#ifndef COMMON_IRQ_H
#define COMMON_IRQ_H
hv: pirq: clean up irq handlers There are several similar irq handlers with confusing function names and it's not friendly to call update_irq_handler() to update a proper handler after request_irq(). With this commit, a single generic irq handler is being used, in which, no lock need to be acquired because our design could guarantee there is no concurrent irq handling and irq handler request/free. A flags field is added to irq_desc struct to select the proper processing flow for an irq. Irqflags is defined as follows: IRQF_NONE (0U) IRQF_LEVEL (1U << 1U) /* 1: level trigger; 0: edge trigger */ IRQF_PT (1U << 2U) /* 1: for passthrough dev */ Because we have only one irq handler, update_irq_handler() should be replace by set_irq_trigger_mode(), whichs set trigger mode flag of a certian irq. Accordingly, the code where called update_irq_handler() need to be updated. Signed-off-by: Yan, Like <like.yan@intel.com> Acked-by: Anthony Xu <anthony.xu@intel.com>
2018-08-16 20:21:11 +08:00
#define IRQF_NONE (0U)
#define IRQF_LEVEL (1U << 1U) /* 1: level trigger; 0: edge trigger */
#define IRQF_PT (1U << 2U) /* 1: for passthrough dev */
hv: pirq: add a header for common data struct and APIs - add a commont head file include/common/irq.h, to include the common data structure and APIs; - move the common data struct and APIs from arch/x86/irq.h to the common header. Signed-off-by: Yan, Like <like.yan@intel.com> Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-06-20 16:30:55 +08:00
hv:Changed several APIs to void type Since these APIs always return 0, change them to void type, vcpu_set_cr0() vmx_write_cr0() vcpu_set_cr4() vmx_write_cr4() kick_notification() tsc_deadline_handler() dmar_fault_handler() ptdev_interrupt_handler() Signed-off-by: Mingqiang Chi <mingqiang.chi@intel.com> Reviewed-by: Junjie Mao <junjie.mao@intel.com>
2018-08-22 11:12:37 +08:00
typedef void (*irq_action_t)(uint32_t irq, void *priv_data);
hv: pirq: add a header for common data struct and APIs - add a commont head file include/common/irq.h, to include the common data structure and APIs; - move the common data struct and APIs from arch/x86/irq.h to the common header. Signed-off-by: Yan, Like <like.yan@intel.com> Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-06-20 16:30:55 +08:00
doc: hv: add comments to irq APIs for documentation Tracked-On: #1595 Signed-off-by: Yan, Like <like.yan@intel.com>
2018-10-31 15:12:33 +08:00
/**
* @brief Interrupt descriptor
*
* Any field change in below required lock protection with irqsave
*/
hv: pirq: add a header for common data struct and APIs - add a commont head file include/common/irq.h, to include the common data structure and APIs; - move the common data struct and APIs from arch/x86/irq.h to the common header. Signed-off-by: Yan, Like <like.yan@intel.com> Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-06-20 16:30:55 +08:00
struct irq_desc {
doc: hv: add comments to irq APIs for documentation Tracked-On: #1595 Signed-off-by: Yan, Like <like.yan@intel.com>
2018-10-31 15:12:33 +08:00
uint32_t irq; /**< index to irq_desc_base */
uint32_t vector; /**< assigned vector */
hv: pirq: remove unnecessary dev_handler_node struct Since we don't support shared irq, dev_handler_node which works as action node, is not needed anymore. This commit removes the dev_handler_node struct and does some relevant changes, including: - moves necessary fields to struct irq_desc: action, priv_data, name; and removes unused handler_data; - changes return type of pri_/normal_register_handler() from dev_handler_node* to int32_t, which is irq num (>= 0) on success, and errno (> 0) on failure. - changes unregister_irq_handler() to take argument unint32_t instead of dev_handler_node*; - changes are made to the places where these APIs are called. Signed-off-by: Yan, Like <like.yan@intel.com> Reviewed-by: Eddie Dong <eddie.dong@intel.com>
2018-08-07 14:33:02 +08:00
doc: hv: add comments to irq APIs for documentation Tracked-On: #1595 Signed-off-by: Yan, Like <like.yan@intel.com>
2018-10-31 15:12:33 +08:00
irq_action_t action; /**< callback registered from component */
void *priv_data; /**< irq_action private data */
uint32_t flags; /**< flags for trigger mode/ptdev */
hv: pirq: remove unnecessary dev_handler_node struct Since we don't support shared irq, dev_handler_node which works as action node, is not needed anymore. This commit removes the dev_handler_node struct and does some relevant changes, including: - moves necessary fields to struct irq_desc: action, priv_data, name; and removes unused handler_data; - changes return type of pri_/normal_register_handler() from dev_handler_node* to int32_t, which is irq num (>= 0) on success, and errno (> 0) on failure. - changes unregister_irq_handler() to take argument unint32_t instead of dev_handler_node*; - changes are made to the places where these APIs are called. Signed-off-by: Yan, Like <like.yan@intel.com> Reviewed-by: Eddie Dong <eddie.dong@intel.com>
2018-08-07 14:33:02 +08:00
hv: pirq: clean up unnecessary fields of irq_desc This commit cleans up fiels of struct irq_desc: - remove name, irq_desc_state, irq_cnt and irq_lost_cnt which are not used. - remove irq_ prefix of irq_lock field of struct irq_desc; - change enum irq_state to enum irq_use_state; Signed-off-by: Yan, Like <like.yan@intel.com> Reviewed-by: Li, Fei <fei1.li@intel.com> Acked-by: Anthony Xu <anthony.xu@intel.com>
2018-08-16 15:05:46 +08:00
spinlock_t lock;
HV:Added implementation for PMI handler function irq.c/.h: Added new variables(ctx_rflags, ctx_rip, ctx_cs) in irq_desc On each interrupt this information is populated Added api's to access the irq_desc members profiling.c: profiling_pmi_handler:On each PMI generates gets the context and other information that caused it Tracked-On: projectacrn#1409 Acked-by: Eddie Dong <eddie.dong@intel.com> Signed-off-by: Chinthapally, Manisha <manisha.chinthapally@intel.com>
2018-10-23 07:39:41 +08:00
#ifdef PROFILING_ON
uint64_t ctx_rip;
uint64_t ctx_rflags;
uint64_t ctx_cs;
#endif
hv: pirq: add a header for common data struct and APIs - add a commont head file include/common/irq.h, to include the common data structure and APIs; - move the common data struct and APIs from arch/x86/irq.h to the common header. Signed-off-by: Yan, Like <like.yan@intel.com> Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-06-20 16:30:55 +08:00
};
doc: hv: add comments to irq APIs for documentation Tracked-On: #1595 Signed-off-by: Yan, Like <like.yan@intel.com>
2018-10-31 15:12:33 +08:00
/**
* @brief Request an interrupt
*
* Request interrupt num if not specified, and register irq action for the
* specified/allocated irq.
*
* @param[in] req_irq irq_num to request, if IRQ_INVALID, a free irq
* number will be allocated
* @param[in] action_fn Function to be called when the IRQ occurs
* @param[in] priv_data Private data for action function.
* @param[in] flags Interrupt type flags, including:
* IRQF_NONE;
* IRQF_LEVEL - 1: level trigger; 0: edge trigger;
* IRQF_PT - 1: for passthrough dev
*
doc: replace return with retval `@return` is dedicated for brief description of return values, not for comments stating actual return values. In addition, sphinx + breathe does not join multiple adjacent `@return`. This results in multiple `Return` sections in the generated document, which is confusing. This patch replaces `@return` with `@retval` for the lists of return values. Adjacent `@retval` can be joined into one list by breathe. v1 -> v2: * Replace return value descriptions like `negative` and `positive` with expressions like `<0` and `>0` in `@retval`. * Keep the list of `@retval` comprehensive, even when there is a `@return` to generally describe what the return value means. * Drop duplicated `@return` when it does not give more information than the `@retval` list. Tracked-On: #1595 Signed-off-by: Junjie Mao <junjie.mao@intel.com>
2018-11-21 17:28:28 +08:00
* @retval >=0 on success
* @retval IRQ_INVALID on failure
doc: hv: add comments to irq APIs for documentation Tracked-On: #1595 Signed-off-by: Yan, Like <like.yan@intel.com>
2018-10-31 15:12:33 +08:00
*/
hv: treewide: fix 'Function prototype/defn param type mismatch' Fix the parameter type mismatch between API declaration and definition. Tracked-On: #861 Signed-off-by: Shiqing Gao <shiqing.gao@intel.com> Acked-by: Anthony Xu <anthony.xu@intel.com>
2018-08-20 15:32:14 +08:00
int32_t request_irq(uint32_t req_irq, irq_action_t action_fn, void *priv_data,
uint32_t flags);
hv: pirq: remove unnecessary dev_handler_node struct Since we don't support shared irq, dev_handler_node which works as action node, is not needed anymore. This commit removes the dev_handler_node struct and does some relevant changes, including: - moves necessary fields to struct irq_desc: action, priv_data, name; and removes unused handler_data; - changes return type of pri_/normal_register_handler() from dev_handler_node* to int32_t, which is irq num (>= 0) on success, and errno (> 0) on failure. - changes unregister_irq_handler() to take argument unint32_t instead of dev_handler_node*; - changes are made to the places where these APIs are called. Signed-off-by: Yan, Like <like.yan@intel.com> Reviewed-by: Eddie Dong <eddie.dong@intel.com>
2018-08-07 14:33:02 +08:00
doc: hv: add comments to irq APIs for documentation Tracked-On: #1595 Signed-off-by: Yan, Like <like.yan@intel.com>
2018-10-31 15:12:33 +08:00
/**
* @brief Free an interrupt
*
* Free irq num and unregister the irq action.
*
* @param[in] irq irq_num to be freed
*/
hv: pirq: rename common irq APIs This commit cleans up the irq APIs which are a bit confusing. - pri_register_handler(), normal_register_handler() and common_register_handler() into request_irq(), and removed the unnecessary struct irq_request_info; - rename the unregister_common_handler() to free_irq(); After the revision, the common irq APIs becomes: - int32_t request_irq(uint32_t irq, irq_action_t action_fn, void *action_data, const char *name) - void free_irq(uint32_t irq) Signed-off-by: Yan, Like <like.yan@intel.com> Reviewed-by: Li, Fei1 <fei1.li@intel.com> Acked-by: Anthony Xu <anthony.xu@intel.com>
2018-08-05 23:29:02 +08:00
void free_irq(uint32_t irq);
hv: pirq: add a header for common data struct and APIs - add a commont head file include/common/irq.h, to include the common data structure and APIs; - move the common data struct and APIs from arch/x86/irq.h to the common header. Signed-off-by: Yan, Like <like.yan@intel.com> Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-06-20 16:30:55 +08:00
doc: hv: add comments to irq APIs for documentation Tracked-On: #1595 Signed-off-by: Yan, Like <like.yan@intel.com>
2018-10-31 15:12:33 +08:00
/**
* @brief Set interrupt trigger mode
*
* Set the irq trigger mode: edge-triggered or level-triggered
*
* @param[in] irq irq_num of interupt to be set
* @param[in] is_level_triggered Trigger mode to set
*/
void set_irq_trigger_mode(uint32_t irq, bool is_level_triggered);
hv: pirq: add a header for common data struct and APIs - add a commont head file include/common/irq.h, to include the common data structure and APIs; - move the common data struct and APIs from arch/x86/irq.h to the common header. Signed-off-by: Yan, Like <like.yan@intel.com> Acked-by: Eddie Dong <eddie.dong@intel.com>
2018-06-20 16:30:55 +08:00
#endif /* COMMON_IRQ_H */