tests: pm: device_runtime_api: add retval to test_driver

Add API to configure the return value of pm actions of the
test_driver used by the device_runtime_api test suite.

Signed-off-by: Bjarki Arge Andreasen <bjarki.andreasen@nordicsemi.no>