zephyr/kernel/microkernel/include/kernel_main.h
Daniel Leung 74c8852d05 microkernel: remove kernel service dispatch table
This change removes the internal number-to-function mapping
of microkernel services. Instead, function pointers are used
to specify which service to use.

This is in preparation for private kernel objects. Before this,
only kernel objects that are defined in MDEF files would have
corresponding functions included in the final binary, via sysgen
by populating an array of number-to-function mapping. This
causes an issue when a certain type of objects are all defined
with source code, and never in MDEF file. The corresponding
mapping would be deleted, and the functions are never included
in the binary. For example, if no mutexes are defined in MDEF
file, the _k_mutex_*() functions would not be included.

With this change, any usage of private kernel objects will hint
to the linker that those functions are needed, and should not be
removed from final binary.

Change-Id: If48864abcd6471bcb7964ec00fe668bcabe3239b
Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2016-02-05 20:14:46 -05:00

305 lines
8.7 KiB
C

/*
* Copyright (c) 1997-2012, 2014 Wind River Systems, Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1) Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2) Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* 3) Neither the name of Wind River Systems nor the names of its contributors
* may be used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/*
* @file
* @brief Non-public microkernel APIs referenced by kernel_main.c.
*/
#ifndef _ENTRIES_H
#define _ENTRIES_H
#ifdef __cplusplus
extern "C" {
#endif
/* Format of a task's entry routine and (optional) abort routine */
typedef void (*taskstartfunction)(void);
typedef void (*taskabortfunction)(void);
/* APIs referenced by generated data structures */
extern int _k_ticker(int event);
/* APIs referenced by generated routines */
extern void _k_pipe_init(void);
extern void _k_mem_map_init(void);
extern void _k_mem_pool_init(void);
extern void _k_kernel_init(void);
extern int _k_kernel_idle(void);
/* Format of routines invoked by microkernel server */
typedef void (*kernelfunc)(struct k_args *);
/* Jumptable entrypoints */
extern void _k_nop(struct k_args *);
extern void _k_offload_to_fiber(struct k_args *);
extern void _k_workload_get(struct k_args *);
/**
*
* @brief Handle semaphore signal request
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_signal(struct k_args *);
/**
*
* @brief Handle signal semaphore group request
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_group_signal(struct k_args *);
/**
*
* @brief Handle semaphore reset request
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_reset(struct k_args *);
/**
*
* @brief Handle semaphore group reset request
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_group_reset(struct k_args *);
/**
*
* @brief Handle internal wait request on a semaphore involved in a
* semaphore group wait request
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_wait_request(struct k_args *);
/**
*
* @brief Reply to a semaphore wait request
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_wait_reply(struct k_args *);
/**
*
* @brief Reply to a semaphore wait request with timeout.
*
* @param A Pointer to a k_args structure.
*
* @return N/A
*
* @sa _k_sem_wait_reply
*/
extern void _k_sem_wait_reply_timeout(struct k_args *A);
/**
*
* @brief Handle semaphore group wait request
*
* This routine splits the single semaphore group wait request into several
* internal wait requests--one for each semaphore in the group.
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_group_wait_any(struct k_args *);
/**
*
* @brief Handle semaphore test and wait request
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_group_wait_request(struct k_args *);
/**
*
* @brief Handle semaphore ready request
*
* This routine only applies to semaphore group wait requests. It identifies
* the one semaphore in the group that "won" the semaphore group wait request
* before triggering the semaphore group timeout handler.
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_group_ready(struct k_args *);
/**
*
* @brief Handle cancellation of a semaphore involved in a
* semaphore group wait request
*
* This routine only applies to semaphore group wait requests. It is invoked
* for each semaphore in the semaphore group that "lost" the semaphore group
* wait request.
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_group_wait_cancel(struct k_args *);
/**
*
* @brief Handle acceptance of the ready semaphore request
*
* This routine only applies to semaphore group wait requests. It handles
* the request for the one semaphore in the group that "wins" the semaphore
* group wait request.
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_group_wait_accept(struct k_args *);
/**
*
* @brief Finish handling incomplete waits on semaphores
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_group_wait(struct k_args *);
/**
*
* @brief Handle semaphore group timeout request
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_group_wait_timeout(struct k_args *);
/**
*
* @brief Handle semaphore inquiry request
*
* @param k_args Pointer to a k_args structure.
*
* @return N/A
*/
extern void _k_sem_inquiry(struct k_args *);
extern void _k_mutex_lock_request(struct k_args *);
extern void _k_mutex_lock_reply(struct k_args *);
extern void _k_mutex_lock_reply_timeout(struct k_args *);
extern void _k_mutex_unlock(struct k_args *);
extern void _k_fifo_enque_request(struct k_args *);
extern void _k_fifo_enque_reply(struct k_args *);
extern void _k_fifo_enque_reply_timeout(struct k_args *);
extern void _k_fifo_deque_request(struct k_args *);
extern void _k_fifo_deque_reply(struct k_args *);
extern void _k_fifo_deque_reply_timeout(struct k_args *);
extern void _k_fifo_ioctl(struct k_args *);
extern void _k_mbox_send_request(struct k_args *);
extern void _k_mbox_send_reply(struct k_args *);
extern void _k_mbox_send_ack(struct k_args *);
extern void _k_mbox_send_data(struct k_args *);
extern void _k_mbox_receive_request(struct k_args *);
extern void _k_mbox_receive_reply(struct k_args *);
extern void _k_mbox_receive_ack(struct k_args *);
extern void _k_mbox_receive_data(struct k_args *);
extern void _k_time_elapse(struct k_args *);
extern void _k_task_sleep(struct k_args *);
extern void _k_task_wakeup(struct k_args *);
extern void _k_task_op(struct k_args *);
extern void _k_task_group_op(struct k_args *);
extern void _k_task_priority_set(struct k_args *);
extern void _k_task_yield(struct k_args *);
extern void _k_mem_map_alloc(struct k_args *);
extern void _k_mem_map_dealloc(struct k_args *);
extern void _k_timer_alloc(struct k_args *);
extern void _k_timer_dealloc(struct k_args *);
extern void _k_timer_start(struct k_args *);
extern void _k_timer_stop(struct k_args *);
extern void _k_mem_map_alloc_timeout(struct k_args *);
extern void _k_event_test(struct k_args *);
extern void _k_event_handler_set(struct k_args *);
extern void _k_event_signal(struct k_args *);
extern void _k_mem_pool_block_get(struct k_args *);
extern void _k_mem_pool_block_release(struct k_args *);
extern void _k_block_waiters_get(struct k_args *);
extern void _k_mem_pool_block_get_timeout_handle(struct k_args *);
extern void _k_defrag(struct k_args *);
extern void _k_movedata_request(struct k_args *Req);
extern void K_mvdsndreq(struct k_args *SndReq);
extern void K_mvdrcvreq(struct k_args *RcvReq);
extern void K_rawdata(struct k_args *DataPacket);
extern void K_mvdsndack(struct k_args *SndDAck);
extern void K_mvdrcvack(struct k_args *RcvDAck);
extern void _k_pipe_put_request(struct k_args *Writer);
extern void _k_pipe_put_timeout(struct k_args *Writer);
extern void _k_pipe_put_reply(struct k_args *Writer);
extern void _k_pipe_put_ack(struct k_args *Writer);
extern void _k_pipe_get_request(struct k_args *Reader);
extern void _k_pipe_get_timeout(struct k_args *Reader);
extern void _k_pipe_get_reply(struct k_args *Reader);
extern void _k_pipe_get_ack(struct k_args *Reader);
extern void _k_pipe_movedata_ack(struct k_args *pEOXfer);
extern void _k_event_test_timeout(struct k_args *A);
#ifdef __cplusplus
}
#endif
#endif /* _ENTRIES_H */