#pragma once

/*
 *   This file is part of open_agb_firm
 *   Copyright (C) 2021 derrek, profi200
 *
 *   This program is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "kernel.h"


#ifdef __cplusplus
extern "C"
{
#endif

// TODO: Implement this using semaphores?



/**
 * @brief      Creates a new kernel mutex.
 *
 * @return     The KHandle of the mutex or NULL on error.
 */
KHandle createMutex(void);

/**
 * @brief      Deletes a kernel mutex.
 *
 * @param[in]  kmutex  The KHandle of the mutex.
 */
void deleteMutex(KHandle const kmutex);

/**
 * @brief      Locks a kernel mutex.
 *
 * @param[in]  kmutex  The KHandle of the mutex.
 *
 * @return     Returns the result. See Kres in kernel.h.
 */
KRes lockMutex(KHandle const kmutex);

/**
 * @brief      Unlocks a kernel mutex.
 *
 * @param[in]  kmutex  The KHandle of the mutex.
 *
 * @return     Returns KRES_NO_PERMISSIONS immediately if the current task
 * @return     is not the owner. Otherwise KRES_OK.
 */
KRes unlockMutex(KHandle const kmutex);

#ifdef __cplusplus
} // extern "C"
#endif
