Pratyush Mallick / Mbed OS testing

this is testing

app/noos_mbed/include/irq.h@0:3afcd581558d, 2021-01-14 (annotated)

Committer:
pmallick
Date:
Thu Jan 14 18:54:16 2021 +0530
Revision:
0:3afcd581558d
this is testing

Who changed what in which revision?

UserRevisionLine numberNew contents of line
pmallick 0:3afcd581558d 1 /***************************************************************************//**
pmallick 0:3afcd581558d 2 * @file irq.h
pmallick 0:3afcd581558d 3 * @brief Header file of IRQ interface.
pmallick 0:3afcd581558d 4 * @author Cristian Pop (cristian.pop@analog.com)
pmallick 0:3afcd581558d 5 ********************************************************************************
pmallick 0:3afcd581558d 6 * Copyright 2019(c) Analog Devices, Inc.
pmallick 0:3afcd581558d 7 *
pmallick 0:3afcd581558d 8 * All rights reserved.
pmallick 0:3afcd581558d 9 *
pmallick 0:3afcd581558d 10 * Redistribution and use in source and binary forms, with or without
pmallick 0:3afcd581558d 11 * modification, are permitted provided that the following conditions are met:
pmallick 0:3afcd581558d 12 * - Redistributions of source code must retain the above copyright
pmallick 0:3afcd581558d 13 * notice, this list of conditions and the following disclaimer.
pmallick 0:3afcd581558d 14 * - Redistributions in binary form must reproduce the above copyright
pmallick 0:3afcd581558d 15 * notice, this list of conditions and the following disclaimer in
pmallick 0:3afcd581558d 16 * the documentation and/or other materials provided with the
pmallick 0:3afcd581558d 17 * distribution.
pmallick 0:3afcd581558d 18 * - Neither the name of Analog Devices, Inc. nor the names of its
pmallick 0:3afcd581558d 19 * contributors may be used to endorse or promote products derived
pmallick 0:3afcd581558d 20 * from this software without specific prior written permission.
pmallick 0:3afcd581558d 21 * - The use of this software may or may not infringe the patent rights
pmallick 0:3afcd581558d 22 * of one or more patent holders. This license does not release you
pmallick 0:3afcd581558d 23 * from the requirement that you obtain separate licenses from these
pmallick 0:3afcd581558d 24 * patent holders to use this software.
pmallick 0:3afcd581558d 25 * - Use of the software either in source or binary form, must be run
pmallick 0:3afcd581558d 26 * on or directly connected to an Analog Devices Inc. component.
pmallick 0:3afcd581558d 27 *
pmallick 0:3afcd581558d 28 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
pmallick 0:3afcd581558d 29 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
pmallick 0:3afcd581558d 30 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
pmallick 0:3afcd581558d 31 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
pmallick 0:3afcd581558d 32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
pmallick 0:3afcd581558d 33 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
pmallick 0:3afcd581558d 34 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
pmallick 0:3afcd581558d 35 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
pmallick 0:3afcd581558d 36 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
pmallick 0:3afcd581558d 37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
pmallick 0:3afcd581558d 38 *******************************************************************************/
pmallick 0:3afcd581558d 39
pmallick 0:3afcd581558d 40 #ifndef IRQ_H_
pmallick 0:3afcd581558d 41 #define IRQ_H_
pmallick 0:3afcd581558d 42
pmallick 0:3afcd581558d 43 /******************************************************************************/
pmallick 0:3afcd581558d 44 /***************************** Include Files **********************************/
pmallick 0:3afcd581558d 45 /******************************************************************************/
pmallick 0:3afcd581558d 46
pmallick 0:3afcd581558d 47 #include <stdint.h>
pmallick 0:3afcd581558d 48
pmallick 0:3afcd581558d 49 /******************************************************************************/
pmallick 0:3afcd581558d 50 /*************************** Types Declarations *******************************/
pmallick 0:3afcd581558d 51 /******************************************************************************/
pmallick 0:3afcd581558d 52
pmallick 0:3afcd581558d 53 /**
pmallick 0:3afcd581558d 54 * @enum irq_uart_event_e
pmallick 0:3afcd581558d 55 * @brief Possible events for uart interrupt
pmallick 0:3afcd581558d 56 */
pmallick 0:3afcd581558d 57 enum irq_uart_event_e {
pmallick 0:3afcd581558d 58 /** Write operation finalized */
pmallick 0:3afcd581558d 59 WRITE_DONE,
pmallick 0:3afcd581558d 60 /** Read operation finalized */
pmallick 0:3afcd581558d 61 READ_DONE,
pmallick 0:3afcd581558d 62 /** An error occurred */
pmallick 0:3afcd581558d 63 ERROR_RW
pmallick 0:3afcd581558d 64 };
pmallick 0:3afcd581558d 65
pmallick 0:3afcd581558d 66 /**
pmallick 0:3afcd581558d 67 * @struct irq_init_param
pmallick 0:3afcd581558d 68 * @brief Structure holding the initial parameters for Interrupt Request.
pmallick 0:3afcd581558d 69 */
pmallick 0:3afcd581558d 70 struct irq_init_param {
pmallick 0:3afcd581558d 71 /** Interrupt request controller ID. */
pmallick 0:3afcd581558d 72 uint32_t irq_ctrl_id;
pmallick 0:3afcd581558d 73 /** IRQ extra parameters (device specific) */
pmallick 0:3afcd581558d 74 void *extra;
pmallick 0:3afcd581558d 75 };
pmallick 0:3afcd581558d 76
pmallick 0:3afcd581558d 77 /**
pmallick 0:3afcd581558d 78 * @struct irq_desc
pmallick 0:3afcd581558d 79 * @brief Structure for Interrupt Request descriptor.
pmallick 0:3afcd581558d 80 */
pmallick 0:3afcd581558d 81 struct irq_ctrl_desc {
pmallick 0:3afcd581558d 82 /** Interrupt request controller ID. */
pmallick 0:3afcd581558d 83 uint32_t irq_ctrl_id;
pmallick 0:3afcd581558d 84 /** IRQ extra parameters (device specific) */
pmallick 0:3afcd581558d 85 void *extra;
pmallick 0:3afcd581558d 86 };
pmallick 0:3afcd581558d 87
pmallick 0:3afcd581558d 88 /**
pmallick 0:3afcd581558d 89 * @struct callback_desc
pmallick 0:3afcd581558d 90 * @brief Structure describing a callback to be registered
pmallick 0:3afcd581558d 91 */
pmallick 0:3afcd581558d 92 struct callback_desc {
pmallick 0:3afcd581558d 93 /**
pmallick 0:3afcd581558d 94 * Callback to be called when the event an event occurs
pmallick 0:3afcd581558d 95 */
pmallick 0:3afcd581558d 96 void(*callback)(void);
pmallick 0:3afcd581558d 97 /** Parameter to be passed when the callback is called */
pmallick 0:3afcd581558d 98 void *ctx;
pmallick 0:3afcd581558d 99 /** Platform specific configuration for a callback */
pmallick 0:3afcd581558d 100 void *config;
pmallick 0:3afcd581558d 101 };
pmallick 0:3afcd581558d 102
pmallick 0:3afcd581558d 103 /******************************************************************************/
pmallick 0:3afcd581558d 104 /************************ Functions Declarations ******************************/
pmallick 0:3afcd581558d 105 /******************************************************************************/
pmallick 0:3afcd581558d 106
pmallick 0:3afcd581558d 107 /* Initialize a interrupt controller peripheral. */
pmallick 0:3afcd581558d 108 int32_t irq_ctrl_init(struct irq_ctrl_desc **desc,
pmallick 0:3afcd581558d 109 const struct irq_init_param *param);
pmallick 0:3afcd581558d 110
pmallick 0:3afcd581558d 111 /* Free the resources allocated by irq_ctrl_init(). */
pmallick 0:3afcd581558d 112 int32_t irq_ctrl_remove(struct irq_ctrl_desc *desc);
pmallick 0:3afcd581558d 113
pmallick 0:3afcd581558d 114 /* Register a callback to handle the irq events */
pmallick 0:3afcd581558d 115 int32_t irq_register_callback(struct irq_ctrl_desc *desc,
pmallick 0:3afcd581558d 116 uint32_t irq_id,
pmallick 0:3afcd581558d 117 struct callback_desc *callback_desc);
pmallick 0:3afcd581558d 118
pmallick 0:3afcd581558d 119 /* Unregisters a generic IRQ handling function */
pmallick 0:3afcd581558d 120 int32_t irq_unregister(struct irq_ctrl_desc *desc, uint32_t irq_id);
pmallick 0:3afcd581558d 121
pmallick 0:3afcd581558d 122 /* Global interrupt enable */
pmallick 0:3afcd581558d 123 int32_t irq_global_enable(struct irq_ctrl_desc *desc);
pmallick 0:3afcd581558d 124
pmallick 0:3afcd581558d 125 /* Global interrupt disable */
pmallick 0:3afcd581558d 126 int32_t irq_global_disable(struct irq_ctrl_desc *desc);
pmallick 0:3afcd581558d 127
pmallick 0:3afcd581558d 128 /* Enable specific interrupt */
pmallick 0:3afcd581558d 129 int32_t irq_enable(struct irq_ctrl_desc *desc, uint32_t irq_id);
pmallick 0:3afcd581558d 130
pmallick 0:3afcd581558d 131 /* Disable specific interrupt */
pmallick 0:3afcd581558d 132 int32_t irq_disable(struct irq_ctrl_desc *desc, uint32_t irq_id);
pmallick 0:3afcd581558d 133
pmallick 0:3afcd581558d 134 #endif // IRQ_H_