Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

features/netsocket/emac_stack_mem.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /* mbed Microcontroller Library
elessair 0:f269e3021894 2 * Copyright (c) 2016 ARM Limited
elessair 0:f269e3021894 3 *
elessair 0:f269e3021894 4 * Licensed under the Apache License, Version 2.0 (the "License");
elessair 0:f269e3021894 5 * you may not use this file except in compliance with the License.
elessair 0:f269e3021894 6 * You may obtain a copy of the License at
elessair 0:f269e3021894 7 *
elessair 0:f269e3021894 8 * http://www.apache.org/licenses/LICENSE-2.0
elessair 0:f269e3021894 9 *
elessair 0:f269e3021894 10 * Unless required by applicable law or agreed to in writing, software
elessair 0:f269e3021894 11 * distributed under the License is distributed on an "AS IS" BASIS,
elessair 0:f269e3021894 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
elessair 0:f269e3021894 13 * See the License for the specific language governing permissions and
elessair 0:f269e3021894 14 * limitations under the License.
elessair 0:f269e3021894 15 */
elessair 0:f269e3021894 16 #ifndef MBED_EMAC_STACK_MEM_H
elessair 0:f269e3021894 17 #define MBED_EMAC_STACK_MEM_H
elessair 0:f269e3021894 18
elessair 0:f269e3021894 19 #if DEVICE_EMAC
elessair 0:f269e3021894 20
elessair 0:f269e3021894 21 #include <stdint.h>
elessair 0:f269e3021894 22
elessair 0:f269e3021894 23 /**
elessair 0:f269e3021894 24 * Stack memory module
elessair 0:f269e3021894 25 *
elessair 0:f269e3021894 26 * This interface provides abstraction for memory modules used in different IP stacks (often to accommodate zero copy).
elessair 0:f269e3021894 27 * Emac interface may be required to accept output packets and provide received data using this stack specific API.
elessair 0:f269e3021894 28 * This header should be implemented for each IP stack, so that we keep emacs module independent.
elessair 0:f269e3021894 29 */
elessair 0:f269e3021894 30 typedef void emac_stack_mem_t;
elessair 0:f269e3021894 31 typedef void emac_stack_mem_chain_t;
elessair 0:f269e3021894 32 typedef void emac_stack_t;
elessair 0:f269e3021894 33
elessair 0:f269e3021894 34 /**
elessair 0:f269e3021894 35 * Allocates stack memory
elessair 0:f269e3021894 36 *
elessair 0:f269e3021894 37 * @param stack Emac stack context
elessair 0:f269e3021894 38 * @param size Size of memory to allocate
elessair 0:f269e3021894 39 * @param align Memory alignment requirements
elessair 0:f269e3021894 40 * @return Allocated memory struct, or NULL in case of error
elessair 0:f269e3021894 41 */
elessair 0:f269e3021894 42 emac_stack_mem_t *emac_stack_mem_alloc(emac_stack_t* stack, uint32_t size, uint32_t align);
elessair 0:f269e3021894 43
elessair 0:f269e3021894 44 /**
elessair 0:f269e3021894 45 * Free memory allocated using @a stack_mem_alloc
elessair 0:f269e3021894 46 *
elessair 0:f269e3021894 47 * @param stack Emac stack context
elessair 0:f269e3021894 48 * @param mem Memory to be freed
elessair 0:f269e3021894 49 */
elessair 0:f269e3021894 50 void emac_stack_mem_free(emac_stack_t* stack, emac_stack_mem_t *mem);
elessair 0:f269e3021894 51
elessair 0:f269e3021894 52 /**
elessair 0:f269e3021894 53 * Return pointer to the payload
elessair 0:f269e3021894 54 *
elessair 0:f269e3021894 55 * @param stack Emac stack context
elessair 0:f269e3021894 56 * @param mem Memory structure
elessair 0:f269e3021894 57 * @return Pointer to the payload
elessair 0:f269e3021894 58 */
elessair 0:f269e3021894 59 void *emac_stack_mem_ptr(emac_stack_t* stack, emac_stack_mem_t *mem);
elessair 0:f269e3021894 60
elessair 0:f269e3021894 61 /**
elessair 0:f269e3021894 62 * Return actual payload size
elessair 0:f269e3021894 63 *
elessair 0:f269e3021894 64 * @param stack Emac stack context
elessair 0:f269e3021894 65 * @param mem Memory structure
elessair 0:f269e3021894 66 * @return Size in bytes
elessair 0:f269e3021894 67 */
elessair 0:f269e3021894 68 uint32_t emac_stack_mem_len(emac_stack_t* stack, emac_stack_mem_t *mem);
elessair 0:f269e3021894 69
elessair 0:f269e3021894 70 /**
elessair 0:f269e3021894 71 * Sets the actual payload size (the allocated payload size will not change)
elessair 0:f269e3021894 72 *
elessair 0:f269e3021894 73 * @param stack Emac stack context
elessair 0:f269e3021894 74 * @param mem Memory structure
elessair 0:f269e3021894 75 * @param len Actual payload size
elessair 0:f269e3021894 76 */
elessair 0:f269e3021894 77 void emac_stack_mem_set_len(emac_stack_t* stack, emac_stack_mem_t *mem, uint32_t len);
elessair 0:f269e3021894 78
elessair 0:f269e3021894 79 /**
elessair 0:f269e3021894 80 * Returns first memory structure from the list and move the head to point to the next node
elessair 0:f269e3021894 81 *
elessair 0:f269e3021894 82 * @param stack Emac stack context
elessair 0:f269e3021894 83 * @param list Pointer to the list
elessair 0:f269e3021894 84 * @return First memory structure from the list
elessair 0:f269e3021894 85 */
elessair 0:f269e3021894 86 emac_stack_mem_t *emac_stack_mem_chain_dequeue(emac_stack_t* stack, emac_stack_mem_chain_t **chain);
elessair 0:f269e3021894 87
elessair 0:f269e3021894 88 /**
elessair 0:f269e3021894 89 * Return total length of the memory chain
elessair 0:f269e3021894 90 *
elessair 0:f269e3021894 91 * @param stack Emac stack context
elessair 0:f269e3021894 92 * @param chain Memory chain
elessair 0:f269e3021894 93 * @return Chain length
elessair 0:f269e3021894 94 */
elessair 0:f269e3021894 95 uint32_t emac_stack_mem_chain_len(emac_stack_t* stack, emac_stack_mem_chain_t *chain);
elessair 0:f269e3021894 96
elessair 0:f269e3021894 97 /**
elessair 0:f269e3021894 98 * Increases the reference counter for the memory
elessair 0:f269e3021894 99 *
elessair 0:f269e3021894 100 * @param stack Emac stack context
elessair 0:f269e3021894 101 * @param mem Memory structure
elessair 0:f269e3021894 102 */
elessair 0:f269e3021894 103 void emac_stack_mem_ref(emac_stack_t* stack, emac_stack_mem_t *mem);
elessair 0:f269e3021894 104
elessair 0:f269e3021894 105 #endif /* DEVICE_EMAC */
elessair 0:f269e3021894 106
elessair 0:f269e3021894 107 #endif /* EMAC_MBED_STACK_MEM_h */