include/grlib/irqamp.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /**
0004  * @file
0005  *
0006  * @ingroup RTEMSDeviceGRLIBIRQAMP
0007  *
0008  * @brief This header file defines the IRQ(A)MP interface.
0009  */
0010
0011 /*
0012  * Copyright (C) 2021 embedded brains GmbH & Co. KG
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 /*
0037  * This file is part of the RTEMS quality process and was automatically
0038  * generated.  If you find something that needs to be fixed or
0039  * worded better please post a report or patch to an RTEMS mailing list
0040  * or raise a bug report:
0041  *
0042  * https://www.rtems.org/bugs.html
0043  *
0044  * For information on updating and regenerating please refer to the How-To
0045  * section in the Software Requirements Engineering chapter of the
0046  * RTEMS Software Engineering manual.  The manual is provided as a part of
0047  * a release.  For development sources please refer to the online
0048  * documentation at:
0049  *
0050  * https://docs.rtems.org
0051  */
0052
0053 /* Generated from spec:/dev/grlib/if/irqamp-header-2 */
0054
0055 #ifndef _GRLIB_IRQAMP_H
0056 #define _GRLIB_IRQAMP_H
0057
0058 #include <stddef.h>
0059 #include <grlib/io.h>
0060 #include <grlib/irqamp-regs.h>
0061
0062 #ifdef __cplusplus
0063 extern "C" {
0064 #endif
0065
0066 /* Generated from spec:/dev/grlib/if/irqamp-get-timestamp */
0067
0068 /**
0069  * @ingroup RTEMSDeviceGRLIBIRQAMP
0070  *
0071  * @brief Gets the interrupt timestamping register bock.
0072  *
0073  * @param irqamp_regs is the IRQ(A)MP register block.
0074  *
0075  * @retval NULL The IRQ(A)MP does not support the interrupt timestamping
0076  *   feature.
0077  *
0078  * @return Returns the interrupt timestamping register block.
0079  */
0080 static inline irqamp_timestamp *irqamp_get_timestamp_registers(
0081   irqamp *irqamp_regs
0082 )
0083 {
0084   irqamp_timestamp *timestamp_regs;
0085   uint32_t itstmpc;
0086
0087   timestamp_regs = &irqamp_regs->itstmp[ 0 ];
0088   itstmpc = grlib_load_32( &timestamp_regs->itstmpc );
0089
0090   if ( IRQAMP_ITSTMPC_TSTAMP_GET( itstmpc ) == 0 ) {
0091     return NULL;
0092   }
0093
0094   return timestamp_regs;
0095 }
0096
0097 #ifdef __cplusplus
0098 }
0099 #endif
0100
0101 #endif /* _GRLIB_IRQAMP_H */