nsapi - Add standardized return types for size and errors #3075

geky · 2016-10-19T14:19:39Z

Note: Backwards compatible user API
Note: Backwards compatible implementation API

Add standardized return types for size and errors:

nsapi_error_t         - enum of errors or 0 for NSAPI_ERROR_OK
nsapi_size_t          - unsigned size of data that could be sent
nsapi_size_or_error_t - either a non-negative size or negative error

Unfortunately, compatibility concerns limit this types to signed/unsigned ints. It may be worthwhile in the future to switch these types to stricter variants.

As pointed out by @bulislaw, we should also adopt these types in the interfaces that exist in mbed-os:

LWIP
Nanostack
Odin WiFi

from this discusson #2627 (comment)
cc @bulislaw, @kjbracey-arm, @sg-

bulislaw · 2016-10-19T14:27:49Z

I think while doing this kind of change we should also fixup existing vendor implementations eg the Odin board WiFi interface.

geky · 2016-10-19T14:31:48Z

Good idea, I'll add a todo list to the pr body. Feel free to add any interfaces I'm missing.

0xc0170 · 2016-10-26T11:50:23Z

@geky What's the status of this PR?

geky · 2016-10-26T13:43:35Z

Still a work in progress, no blockers, just not the highest priority.

nsapi_error_t - enum of errors or 0 for NSAPI_ERROR_OK nsapi_size_t - unsigned size of data that could be sent nsapi_size_or_error_t - either a non-negative size or negative error

geky · 2016-11-02T20:55:30Z

Should be updated accross all of the network stacks currently in the codebase. The updated types are currently backwards compatible, so we should see no breakages for external interfaces.

Note: I'm currently unable to compile the Odin interface due to this issue #3152

bulislaw · 2016-11-03T09:48:57Z

LGTM
@andreaslarssonublox be aware that that will pop up and it will require merging when you submit the fix for the API change.

0xc0170 · 2016-11-03T12:07:00Z

Open for review @kjbracey-arm, @sg- @andreaslarssonublox

sg- · 2016-11-03T23:09:49Z

LGTM - needs CI 👍

sg- · 2016-11-03T23:10:18Z

/morph nightly-build

bridadan · 2016-11-03T23:32:31Z

/morph test-nightly

mbed-bot · 2016-11-04T14:05:44Z

Result: FAILURE

Your command has finished executing! Here's what you wrote!

/morph test-nightly

Output

mbed Build Number: 995

Test Prep failed!

bridadan · 2016-11-04T14:06:58Z

Failure was my fault, a few machines were stuck in maintenance mode and halted the whole process. Restarting now.

/morph test-nightly

mbed-bot · 2016-11-04T21:51:57Z

Result: SUCCESS

Your command has finished executing! Here's what you wrote!

/morph test-nightly

Output

mbed Build Number: 998

All builds and test passed!

Release mbed OS 5.2.2 and mbed lib v129 Known issues in this release There is currently a DNS resolution failure in Thread mode with this release. This causes a failure in the mbed-os-example-client. This will be fixed in a subsequent release. This can be worked around by reverting to mbed-os-5.2.0 Ports for Upcoming Targets 3011: Add u-blox Sara-N target. ARMmbed#3011 3099: MAX32625 ARMmbed#3099 3151: Add support for FRDM-K82F ARMmbed#3151 3177: New mcu k22512 fixing pr 3136 ARMmbed#3177 Fixes and Changes 2990: [tools] Parallel building of tests ARMmbed#2990 3008: NUCLEO_F072RB: Fix wrong timer channel number on pwm PB_5 pin ARMmbed#3008 3013: STM32xx - Change how the ADC internal pins are checked before pinmap_ ARMmbed#3013 3023: digital_loop tests update for STM32 ARMmbed#3023 3041: [nRF5] - added implementation of API of serial port flow control configuration. ARMmbed#3041 3092: [tools + tests] Adding parallelized build option for iar and uvision exporters ARMmbed#3092 3084: [nrf5] fix in Digital I/O : a gpioe pin was uninitialized badly ARMmbed#3084 3009: TRNG enabled. TRNG APIs implemented. REV A/B/C/D flags removed. Warnings removed ARMmbed#3009 3139: Handle [NOT_SUPPORTED] exception in make.py ARMmbed#3139 3074: Target stm init gcc alignement ARMmbed#3074 3140: [tests] Replacing getchar with RawSerial getc in greentea-client ARMmbed#3140 3158: Added support for 6lowpan PAN ID filter to mbed mesh api configuration ARMmbed#3158 2988: Update of can_api.c fixing ARMmbed#2987 ARMmbed#2988 3175: Updating IAR definition for the NCS36510 for IAR EW v7.8 ARMmbed#3175 3170: [tests] Preventing test from printing before Greentea __sync ARMmbed#3170 3169: [Update of ARMmbed#3014] Usb updates ARMmbed#3169 3143: CFStore fix needed for the Cloud Client ARMmbed#3143 3135: lwip - Fix memory leak in k64f cyclic-buffer overflow ARMmbed#3135 3048: Make update.py test compile examples prior to updating mbed-os version. ARMmbed#3048 3162: lwip/nsapi - Clean up warnings in network code ARMmbed#3162 3161: nsapi - Add better heuristic for the default record of DNS queries ARMmbed#3161 3173: [Exporters] Add a device_name to microbit entry in targets.json ARMmbed#3173 3072: i2c_loop tests update for STM32 ARMmbed#3072 2958: Allowing mbed_app.json files to be discovered for tests. ARMmbed#2958 2969: [nRF52] - switch irq priorities of driver handlers to the lowest level ARMmbed#2969 3078: lwip: Allow several configuration macros to be set externally (bis) ARMmbed#3078 3165: Add address type checks to NanostackInterface ARMmbed#3165 3166: nsapi_dns: Provide 2 IPv6-hosted default servers ARMmbed#3166 3171: [tools] Fixing project.py -S printing problem ARMmbed#3171 3172: [Exporters] New export-build tests ARMmbed#3172 3184: ARMmbed#3183 Compiler warning in trng_api.c with K64F ARMmbed#3184 3185: Update tests to fix build failures. Also make the code similar to oth ARMmbed#3185 3104: [NuMaker] Support CAN and fix PWM CLK error ARMmbed#3104 3182: Exporter documentation ARMmbed#3182 3186: MultiTech mDot - add back SPI3 pins ARMmbed#3186 3187: [Export-Make] Use internal class variable for resolving templates in makefiles ARMmbed#3187 3195: [Exporters - Make-based] Quote the shell call in mkdir and rmdir ARMmbed#3195 3204: [Export build-test] Directory traversal error ARMmbed#3204 3189: [Exporters - Make-based] Force make exporter to search PATH for compilers ARMmbed#3189 3200: Using Popen for uVision and unifying the structure of the build function ARMmbed#3200 3075: nsapi - Add standardized return types for size and errors ARMmbed#3075 3221: u-blox odin w2 drivers update ARMmbed#3221

Ports for Upcoming Targets 3011: Add u-blox Sara-N target. ARMmbed/mbed-os#3011 3099: MAX32625 ARMmbed/mbed-os#3099 3151: Add support for FRDM-K82F ARMmbed/mbed-os#3151 3177: New mcu k22512 fixing pr 3136 ARMmbed/mbed-os#3177 Fixes and Changes 3008: NUCLEO_F072RB: Fix wrong timer channel number on pwm PB_5 pin ARMmbed/mbed-os#3008 3013: STM32xx - Change how the ADC internal pins are checked before pinmap_ ARMmbed/mbed-os#3013 3041: [nRF5] - added implementation of API of serial port flow control configuration. ARMmbed/mbed-os#3041 3084: [nrf5] fix in Digital I/O : a gpioe pin was uninitialized badly ARMmbed/mbed-os#3084 3009: TRNG enabled. TRNG APIs implemented. REV A/B/C/D flags removed. Warnings removed ARMmbed/mbed-os#3009 3074: Target stm init gcc alignement ARMmbed/mbed-os#3074 2988: Update of can_api.c fixing #2987 ARMmbed/mbed-os#2988 3173: [Exporters] Add a device_name to microbit entry in targets.json ARMmbed/mbed-os#3173 2969: [nRF52] - switch irq priorities of driver handlers to the lowest level ARMmbed/mbed-os#2969 3184: #3183 Compiler warning in trng_api.c with K64F ARMmbed/mbed-os#3184 3104: [NuMaker] Support CAN and fix PWM CLK error ARMmbed/mbed-os#3104 3186: MultiTech mDot - add back SPI3 pins ARMmbed/mbed-os#3186 3075: nsapi - Add standardized return types for size and errors ARMmbed/mbed-os#3075 3221: u-blox odin w2 drivers update ARMmbed/mbed-os#3221

geky added type: enhancement needs: review labels Oct 19, 2016

0xc0170 added needs: work and removed needs: review labels Oct 26, 2016

geky added 2 commits November 2, 2016 15:25

nsapi - Added standardized return types for size and errors

ba748ac

nsapi_error_t - enum of errors or 0 for NSAPI_ERROR_OK nsapi_size_t - unsigned size of data that could be sent nsapi_size_or_error_t - either a non-negative size or negative error

nsapi - Adopted standardized return types in lwip

78b9357

geky force-pushed the nsapi-error-size-types-2 branch from 8d0ad53 to 78b9357 Compare November 2, 2016 20:26

nsapi - Adopted standardized return types in the Odin wifi interface

b045c8b

nsapi - Adopted standardized return types in the Nanostack interfaces

00458c3

geky force-pushed the nsapi-error-size-types-2 branch from f86e3e7 to 00458c3 Compare November 2, 2016 20:55

geky added needs: review needs: CI and removed needs: work labels Nov 2, 2016

sg- removed needs: review type: enhancement labels Nov 3, 2016

0xc0170 added release-version: 5.2.2 and removed needs: CI labels Nov 7, 2016

0xc0170 merged commit 7eaf32b into ARMmbed:master Nov 7, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nsapi - Add standardized return types for size and errors #3075

nsapi - Add standardized return types for size and errors #3075

geky commented Oct 19, 2016 •

edited

bulislaw commented Oct 19, 2016

geky commented Oct 19, 2016 •

edited

0xc0170 commented Oct 26, 2016

geky commented Oct 26, 2016

geky commented Nov 2, 2016

bulislaw commented Nov 3, 2016

0xc0170 commented Nov 3, 2016 •

edited

sg- commented Nov 3, 2016

sg- commented Nov 3, 2016

bridadan commented Nov 3, 2016

mbed-bot commented Nov 4, 2016

bridadan commented Nov 4, 2016

mbed-bot commented Nov 4, 2016

nsapi - Add standardized return types for size and errors #3075

nsapi - Add standardized return types for size and errors #3075

Conversation

geky commented Oct 19, 2016 • edited

bulislaw commented Oct 19, 2016

geky commented Oct 19, 2016 • edited

0xc0170 commented Oct 26, 2016

geky commented Oct 26, 2016

geky commented Nov 2, 2016

bulislaw commented Nov 3, 2016

0xc0170 commented Nov 3, 2016 • edited

sg- commented Nov 3, 2016

sg- commented Nov 3, 2016

bridadan commented Nov 3, 2016

mbed-bot commented Nov 4, 2016

Result: FAILURE

Output

bridadan commented Nov 4, 2016

mbed-bot commented Nov 4, 2016

Result: SUCCESS

Output

geky commented Oct 19, 2016 •

edited

geky commented Oct 19, 2016 •

edited

0xc0170 commented Nov 3, 2016 •

edited