1 /**************************************************************************/
2 /*                                                                        */
3 /*       Copyright (c) Microsoft Corporation. All rights reserved.        */
4 /*                                                                        */
5 /*       This software is licensed under the Microsoft Software License   */
6 /*       Terms for Microsoft Azure RTOS. Full text of the license can be  */
7 /*       found in the LICENSE file at https://aka.ms/AzureRTOS_EULA       */
8 /*       and in the root directory of this software.                      */
9 /*                                                                        */
10 /**************************************************************************/
11 
12 
13 /**************************************************************************/
14 /**************************************************************************/
15 /**                                                                       */
16 /** ThreadX Component                                                     */
17 /**                                                                       */
18 /**   Module                                                              */
19 /**                                                                       */
20 /**************************************************************************/
21 /**************************************************************************/
22 
23 #define TXM_MODULE
24 #include "txm_module.h"
25 #ifndef TXM_BYTE_POOL_CREATE_CALL_NOT_USED
26 /**************************************************************************/
27 /*                                                                        */
28 /*  FUNCTION                                               RELEASE        */
29 /*                                                                        */
30 /*    _txe_byte_pool_create                               PORTABLE C      */
31 /*                                                           6.1.10       */
32 /*  AUTHOR                                                                */
33 /*                                                                        */
34 /*    Scott Larson, Microsoft Corporation                                 */
35 /*                                                                        */
36 /*  DESCRIPTION                                                           */
37 /*                                                                        */
38 /*    This function checks for errors in the create byte pool memory      */
39 /*    function.                                                           */
40 /*                                                                        */
41 /*  INPUT                                                                 */
42 /*                                                                        */
43 /*    pool_ptr                          Pointer to pool control block     */
44 /*    name_ptr                          Pointer to byte pool name         */
45 /*    pool_start                        Address of beginning of pool area */
46 /*    pool_size                         Number of bytes in the byte pool  */
47 /*    pool_control_block_size           Size of byte pool control block   */
48 /*                                                                        */
49 /*  OUTPUT                                                                */
50 /*                                                                        */
51 /*    TX_POOL_ERROR                     Invalid byte pool pointer         */
52 /*    TX_PTR_ERROR                      Invalid pool starting address     */
53 /*    TX_SIZE_ERROR                     Invalid pool size                 */
54 /*    TX_CALLER_ERROR                   Invalid caller of this function   */
55 /*    status                            Actual completion status          */
56 /*                                                                        */
57 /*  CALLS                                                                 */
58 /*                                                                        */
59 /*    _txm_module_kernel_call_dispatcher                                  */
60 /*                                                                        */
61 /*  CALLED BY                                                             */
62 /*                                                                        */
63 /*    Module application code                                             */
64 /*                                                                        */
65 /*  RELEASE HISTORY                                                       */
66 /*                                                                        */
67 /*    DATE              NAME                      DESCRIPTION             */
68 /*                                                                        */
69 /*  09-30-2020      Scott Larson            Initial Version 6.1           */
70 /*  01-31-2022      Scott Larson            Modified comments and added   */
71 /*                                            CALL_NOT_USED option,       */
72 /*                                            resulting in version 6.1.10 */
73 /*                                                                        */
74 /**************************************************************************/
_txe_byte_pool_create(TX_BYTE_POOL * pool_ptr,CHAR * name_ptr,VOID * pool_start,ULONG pool_size,UINT pool_control_block_size)75 UINT _txe_byte_pool_create(TX_BYTE_POOL *pool_ptr, CHAR *name_ptr, VOID *pool_start, ULONG pool_size, UINT pool_control_block_size)
76 {
77 
78 UINT return_value;
79 ALIGN_TYPE extra_parameters[3];
80 
81     extra_parameters[0] = (ALIGN_TYPE) pool_start;
82     extra_parameters[1] = (ALIGN_TYPE) pool_size;
83     extra_parameters[2] = (ALIGN_TYPE) pool_control_block_size;
84 
85     /* Call module manager dispatcher.  */
86     return_value = (UINT) (_txm_module_kernel_call_dispatcher)(TXM_BYTE_POOL_CREATE_CALL, (ALIGN_TYPE) pool_ptr, (ALIGN_TYPE) name_ptr, (ALIGN_TYPE) extra_parameters);
87 
88     /* Return value to the caller.  */
89     return(return_value);
90 }
91 #endif
92