| Wolfgang Denk | 4646d2a | 2006-05-30 15:56:48 +0200 | [diff] [blame] | 1 | /** |
| 2 | * ============================================================================ |
| 3 | * = COPYRIGHT |
| 4 | * |
| 5 | * @par |
| 6 | * IXP400 SW Release version 2.0 |
| 7 | * |
| 8 | * -- Copyright Notice -- |
| 9 | * |
| 10 | * @par |
| 11 | * Copyright 2001-2005, Intel Corporation. |
| 12 | * All rights reserved. |
| 13 | * |
| 14 | * @par |
| Wolfgang Denk | c57eadc | 2013-07-28 22:12:47 +0200 | [diff] [blame] | 15 | * SPDX-License-Identifier: BSD-3-Clause |
| Wolfgang Denk | 4646d2a | 2006-05-30 15:56:48 +0200 | [diff] [blame] | 16 | * @par |
| 17 | * -- End of Copyright Notice -- |
| 18 | * = PRODUCT |
| 19 | * Intel(r) IXP425 Software Release |
| 20 | * |
| 21 | * = LIBRARY |
| 22 | * OSSL - Operating System Services Library |
| 23 | * |
| 24 | * = MODULE |
| 25 | * OSSL Abstraction layer header file |
| 26 | * |
| 27 | * = FILENAME |
| 28 | * ix_ossl.h (Replaced by OSAL) |
| 29 | * |
| 30 | * = DESCRIPTION |
| 31 | * This file contains the prototypes of OS-independent wrapper |
| 32 | * functions which allow the programmer not to be tied to a specific |
| 33 | * operating system. The OSSL functions can be divided into three classes: |
| 34 | * |
| 35 | * 1) synchronization-related wrapper functions around thread system calls |
| 36 | * 2) thread-related wrapper functions around thread calls |
| 37 | * 3) transactor/workbench osapi calls -- defined in osApi.h |
| 38 | * |
| 39 | * Both 1 and 2 classes of functions provide Thread Management, Thread |
| 40 | * Synchronization, Mutual Exclusion and Timer primitives. Namely, |
| 41 | * creation and deletion functions as well as the standard "wait" and |
| 42 | * "exit". Additionally, a couple of utility functions which enable to |
| 43 | * pause the execution of a thread are also provided. |
| 44 | * |
| 45 | * The 3rd class provides a slew of other OSAPI functions to handle |
| 46 | * Transactor/WorkBench OS calls. |
| 47 | * |
| 48 | * |
| 49 | * OSSL Thread APIs: |
| 50 | * The OSSL thread functions that allow for thread creation, |
| 51 | * get thread id, thread deletion and set thread priroity. |
| 52 | * |
| 53 | * ix_ossl_thread_create |
| 54 | * ix_ossl_thread_get_id |
| 55 | * ix_ossl_thread_exit |
| 56 | * ix_ossl_thread_kill |
| 57 | * ix_ossl_thread_set_priority |
| 58 | * ix_ossl_thread__delay |
| 59 | * |
| 60 | * OSSL Semaphore APIs: |
| 61 | * The OSSL semaphore functions that allow for initialization, |
| 62 | * posting, waiting and deletion of semaphores. |
| 63 | * |
| 64 | * ix_ossl_sem_init |
| 65 | * ix_ossl_sem_fini |
| 66 | * ix_ossl_sem_take |
| 67 | * ix_ossl_sem_give |
| 68 | * ix_ossl_sem_flush |
| 69 | * |
| 70 | * OSSL Mutex APIs: |
| 71 | * The OSSL wrapper functions that allow for initialization, |
| 72 | * posting, waiting and deletion of mutexes. |
| 73 | * |
| 74 | * ix_ossl_mutex_init |
| 75 | * ix_ossl_mutex_fini |
| 76 | * ix_ossl_mutex_lock |
| 77 | * ix_ossl_mutex_unlock |
| 78 | * |
| 79 | * OSSL Timer APIs: |
| 80 | * The timer APIs provide sleep and get time functions. |
| 81 | * |
| 82 | * ix_ossl_sleep |
| 83 | * ix_ossl_sleep_tick |
| 84 | * ix_ossl_time_get |
| 85 | * |
| 86 | * OSAPIs for Transactor/WorkBench: |
| 87 | * These OSAPI functions are used for transator OS calls. |
| 88 | * They are defined in osApi.h. |
| 89 | * |
| 90 | * Sem_Init |
| 91 | * Sem_Destroy |
| 92 | * Sem_Wait |
| 93 | * Sem_Wait |
| 94 | * Thread_Create |
| 95 | * Thread_Cancel |
| 96 | * Thread_SetPriority |
| 97 | * delayMs |
| 98 | * delayTick |
| 99 | * |
| 100 | * |
| 101 | * |
| 102 | ********************************************************************** |
| 103 | * |
| 104 | * |
| 105 | * = AUTHOR |
| 106 | * Intel Corporation |
| 107 | * |
| 108 | * = ACKNOWLEDGEMENTS |
| 109 | * |
| 110 | * |
| 111 | * = CREATION TIME |
| 112 | * 1/8/2002 1:53:42 PM |
| 113 | * |
| 114 | * = CHANGE HISTORY |
| 115 | * 02/22/2002 : Renamed osapi.h os_api.h |
| 116 | * Moved OS header file includes from OSSL.h to os_api.h |
| 117 | * Moved OS specific datatypes to os_api.h |
| 118 | * Modified data types, macros and functions as per |
| 119 | * 'C' coding guidelines. |
| 120 | * |
| 121 | * |
| 122 | * ============================================================================ |
| 123 | */ |
| 124 | |
| 125 | #ifndef _IX_OSSL_H |
| 126 | #ifndef __doxygen_hide |
| 127 | #define _IX_OSSL_H |
| 128 | #endif /* __doxygen_hide */ |
| 129 | |
| 130 | #include "IxOsalBackward.h" |
| 131 | |
| 132 | #endif /* _IX_OSSL_H */ |
| 133 | |
| 134 | /** |
| 135 | * @} defgroup IxOSSL |
| 136 | */ |