drivers: clock control: clarify possible return values

Document the possible return values from clock_control_get_rate().

Signed-off-by: Henrik Brix Andersen <henrik@brixandersen.dk>