box_id.h

00001 /*
00002  * Copyright (c) 2016, ARM Limited, All Rights Reserved
00003  * SPDX-License-Identifier: Apache-2.0
00004  *
00005  * Licensed under the Apache License, Version 2.0 (the "License"); you may
00006  * not use this file except in compliance with the License.
00007  * You may obtain a copy of the License at
00008  *
00009  * http://www.apache.org/licenses/LICENSE-2.0
00010  *
00011  * Unless required by applicable law or agreed to in writing, software
00012  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
00013  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00014  * See the License for the specific language governing permissions and
00015  * limitations under the License.
00016  */
00017 #ifndef __UVISOR_API_BOX_ID_H__
00018 #define __UVISOR_API_BOX_ID_H__
00019 
00020 #include "api/inc/api.h"
00021 
00022 UVISOR_EXTERN_C_BEGIN
00023 
00024 /* Return the numeric box ID of the current box. */
00025 int uvisor_box_id_self(void);
00026 
00027 /* Return the numeric box ID of the box that is calling through the most recent
00028  * secure gateway. Return -1 if there is no secure gateway calling box. */
00029 int uvisor_box_id_caller(void) UVISOR_DEPRECATED;
00030 
00031 /* Copy the box namespace of the specified box ID to the memory provided by
00032  * box_namespace. The box_namespace's length must be at least
00033  * MAX_BOX_NAMESPACE_LENGTH bytes. Return how many bytes were copied into
00034  * box_namespace. Return UVISOR_ERROR_INVALID_BOX_ID if the provided box ID is
00035  * invalid. Return UVISOR_ERROR_BUFFER_TOO_SMALL if the provided box_namespace
00036  * is too small to hold MAX_BOX_NAMESPACE_LENGTH bytes. Return
00037  * UVISOR_ERROR_BOX_NAMESPACE_ANONYMOUS if the box is anonymous. */
00038 static UVISOR_FORCEINLINE int uvisor_box_namespace(int box_id, char *box_namespace, size_t length)
00039 {
00040     return uvisor_api.box_namespace(box_id, box_namespace, length);
00041 }
00042 
00043 static UVISOR_FORCEINLINE int uvisor_box_id_for_namespace(int * const box_id, const char * const box_namespace)
00044 {
00045     return uvisor_api.box_id_for_namespace(box_id, box_namespace);
00046 }
00047 
00048 UVISOR_EXTERN_C_END
00049 
00050 #endif /* __UVISOR_API_BOX_ID_H__ */