Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expose API interfaces #1

Open
ReinhardKeil opened this issue Oct 17, 2023 · 4 comments
Open

Expose API interfaces #1

ReinhardKeil opened this issue Oct 17, 2023 · 4 comments
Assignees

Comments

@ReinhardKeil
Copy link

The lwIP pack seems not to define the header files that expose the actual API interface. I would have expected that 'socket.h' is exposed.

Came across this issue as we try to define "datasheets" for software components.

@RobertRostohar
Copy link
Collaborator

lwIP has a lot of headers that define various APIs (sockets, tcp, udp, dhcp, icmp, ...).

The pack registers the include directory rather than exposing all individual header files:
<file category="include" name="lwip/src/include/"/>

Note that lwIP source code and application code include the headers with the lwip directory prefix:
#include "lwip/tcp.h"

Therfore it is necessary to register the top level lwip/src/include directory as the include path.

@ReinhardKeil
Copy link
Author

@RobertRostohar thanks for explaining the problem. No change to the PDSC file for now. We need to solve it differently.

@ReinhardKeil
Copy link
Author

@jkrech could you check if it is possible to define 'lwip/tcp.h' as filename. As lwIP has many different API headers, we may need to add a "note" attribute that could supply additional information.

@jkrech
Copy link
Member

jkrech commented Oct 31, 2023

  <file category="header" name="lwip/src/include/lwip/tcp.h" path="lwip/src/include/" />

The path attribute overrides the include path for the compiler to: -I lwip/src/include/

For the include statement this means the user needs to specify: #include "lwip/tcp.h"
(name minus path)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants