mirror of https://github.com/ARMmbed/mbed-os.git
117 lines
3.4 KiB
C
117 lines
3.4 KiB
C
/* mbed Microcontroller Library
|
|
* Copyright (c) 2016 ARM Limited
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
#ifndef MBED_EMAC_STACK_MEM_H
|
|
#define MBED_EMAC_STACK_MEM_H
|
|
|
|
#if DEVICE_EMAC
|
|
|
|
#include <stdint.h>
|
|
|
|
/**
|
|
* Stack memory module
|
|
*
|
|
* This interface provides abstraction for memory modules used in different IP stacks (often to accommodate zero copy).
|
|
* Emac interface may be required to accept output packets and provide received data using this stack specific API.
|
|
* This header should be implemented for each IP stack, so that we keep emacs module independent.
|
|
*/
|
|
typedef void emac_stack_mem_t;
|
|
typedef void emac_stack_mem_chain_t;
|
|
typedef void emac_stack_t;
|
|
|
|
/**
|
|
* Allocates stack memory
|
|
*
|
|
* @param stack Emac stack context
|
|
* @param size Size of memory to allocate
|
|
* @param align Memory alignment requirements
|
|
* @return Allocated memory struct, or NULL in case of error
|
|
*/
|
|
emac_stack_mem_t *emac_stack_mem_alloc(emac_stack_t* stack, uint32_t size, uint32_t align);
|
|
|
|
/**
|
|
* Free memory allocated using @a stack_mem_alloc
|
|
*
|
|
* @param stack Emac stack context
|
|
* @param mem Memory to be freed
|
|
*/
|
|
void emac_stack_mem_free(emac_stack_t* stack, emac_stack_mem_t *mem);
|
|
|
|
/**
|
|
* Copy memory
|
|
*
|
|
* @param stack Emac stack context
|
|
* @param to Memory to copy to
|
|
* @param from Memory to copy from
|
|
*/
|
|
void emac_stack_mem_copy(emac_stack_t* stack, emac_stack_mem_t *to, emac_stack_mem_t *from);
|
|
|
|
/**
|
|
* Return pointer to the payload
|
|
*
|
|
* @param stack Emac stack context
|
|
* @param mem Memory structure
|
|
* @return Pointer to the payload
|
|
*/
|
|
void *emac_stack_mem_ptr(emac_stack_t* stack, emac_stack_mem_t *mem);
|
|
|
|
/**
|
|
* Return actual payload size
|
|
*
|
|
* @param stack Emac stack context
|
|
* @param mem Memory structure
|
|
* @return Size in bytes
|
|
*/
|
|
uint32_t emac_stack_mem_len(emac_stack_t* stack, emac_stack_mem_t *mem);
|
|
|
|
/**
|
|
* Sets the actual payload size (the allocated payload size will not change)
|
|
*
|
|
* @param stack Emac stack context
|
|
* @param mem Memory structure
|
|
* @param len Actual payload size
|
|
*/
|
|
void emac_stack_mem_set_len(emac_stack_t* stack, emac_stack_mem_t *mem, uint32_t len);
|
|
|
|
/**
|
|
* Returns first memory structure from the list and move the head to point to the next node
|
|
*
|
|
* @param stack Emac stack context
|
|
* @param list Pointer to the list
|
|
* @return First memory structure from the list
|
|
*/
|
|
emac_stack_mem_t *emac_stack_mem_chain_dequeue(emac_stack_t* stack, emac_stack_mem_chain_t **chain);
|
|
|
|
/**
|
|
* Return total length of the memory chain
|
|
*
|
|
* @param stack Emac stack context
|
|
* @param chain Memory chain
|
|
* @return Chain length
|
|
*/
|
|
uint32_t emac_stack_mem_chain_len(emac_stack_t* stack, emac_stack_mem_chain_t *chain);
|
|
|
|
/**
|
|
* Increases the reference counter for the memory
|
|
*
|
|
* @param stack Emac stack context
|
|
* @param mem Memory structure
|
|
*/
|
|
void emac_stack_mem_ref(emac_stack_t* stack, emac_stack_mem_t *mem);
|
|
|
|
#endif /* DEVICE_EMAC */
|
|
|
|
#endif /* EMAC_MBED_STACK_MEM_h */
|