include/iprt/arch.h

   1 /** @file
   2  * IPRT - Architecture.
   3  */
   4
   5 /*
   6  * Copyright (C) 2024 Oracle and/or its affiliates.
   7  *
   8  * This file is part of VirtualBox base platform packages, as
   9  * available from https://www.virtualbox.org.
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License
  13  * as published by the Free Software Foundation, in version 3 of the
  14  * License.
  15  *
  16  * This program is distributed in the hope that it will be useful, but
  17  * WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19  * General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, see <https://www.gnu.org/licenses>.
  23  *
  24  * The contents of this file may alternatively be used under the terms
  25  * of the Common Development and Distribution License Version 1.0
  26  * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
  27  * in the VirtualBox distribution, in which case the provisions of the
  28  * CDDL are applicable instead of those of the GPL.
  29  *
  30  * You may elect to license modified versions of this file under the
  31  * terms and conditions of either the GPL or the CDDL or both.
  32  *
  33  * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
  34  */
  35
  36 #ifndef IPRT_INCLUDED_arch_h
  37 #define IPRT_INCLUDED_arch_h
  38 #ifndef RT_WITHOUT_PRAGMA_ONCE
  39 # pragma once
  40 #endif
  41
  42 #include <iprt/types.h>
  43
  44
  45 RT_C_DECLS_BEGIN
  46
  47 /** @defgroup grp_rt_arch RTArch - Architecture
  48  * @ingroup grp_rt
  49  * @{
  50  */
  51
  52 /**
  53  * Converts a RT_ARCH_VAL_XXX value to a string.
  54  *
  55  * @returns Read-only string.
  56  * @param   uArchVal        The value to convert.
  57  *
  58  * @sa      RT_ARCH_VAL, RTSystemGetNativeArch.
  59  */
  60 RTDECL(const char *) RTArchValToString(uint32_t uArchVal);
  61
  62 /** @} */
  63
  64 RT_C_DECLS_END
  65
  66 #endif /* !IPRT_INCLUDED_arch_h */
  67