firmware/os/platform/stm32/inc/plat/taggedPtr.h

/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _STM_TAGGED_PTR_H_
#define _STM_TAGGED_PTR_H_

#include <stdbool.h>
#include <stdint.h>


#define TAG	0x80000000UL  //no valid pointers that we care about in STM32F are at 0x80000000 or further

typedef uintptr_t TaggedPtr;

static inline void *taggedPtrToPtr(TaggedPtr tPtr)
{
    return (void*)tPtr;
}

static inline uintptr_t taggedPtrToUint(TaggedPtr tPtr)
{
    return tPtr &~ TAG;
}

static inline bool taggedPtrIsPtr(TaggedPtr tPtr)
{
    return !(tPtr & TAG);
}

static inline bool taggedPtrIsUint(TaggedPtr tPtr)
{
    return !taggedPtrIsPtr(tPtr);
}

static inline TaggedPtr taggedPtrMakeFromPtr(const void* ptr)
{
    return (uintptr_t)ptr;
}

static inline TaggedPtr taggedPtrMakeFromUint(uintptr_t ptr)
{
    return ptr | TAG;
}

#endif